Personr (Preview)
Create, verify and retrieve applicant data using Personr. Effortlessly verify identity and detect complex fraud.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Full name |
URL | https://personr.co/contact |
help@personr.co |
Connector Metadata | |
---|---|
Publisher | Microsoft |
Website | https://personr.co |
Privacy policy | https://personr.co/legals |
Categories | Data |
Personr simplifies identity verification whilst detecting complex fraud, allowing your business to comply with Know Your Customer (KYC) and Anti-Money Laundering (AML) regulations. The connector allows you to create, verify and request the status and details of an applicant.
Prerequisites
You will need the following to proceed...
- An active/subscribed Personr account. If you aren't currently subscribed, you can do so by going to https://personr.co or by logging into your account and choosing a plan.
How to get credentials
You will need to generate an Authorization Bearer token, which is valid for one year. To do this, send a POST request to https://enterprise.personr.co/api/1.1/wf/api-token-generate
The body should include your account email and password. The API will return a response with your Authorization Bearer token, like in the example below:
{
"status": "success",
"response": {
"token": "your_auth_token",
"expires": "expiry_date_in_seconds"
}
}
When entering the token into the connector during setup, ensure the word Bearer is included before the token:
Bearer your_auth_token
Get started with your connector
To start verifying your first applicant, follow the method below.
Create your first applicant.
Use the Create an Applicant action
, and enter the required details - such as their email, phone number and the flow you'd like them to go through. You can also enter their first name and last name (optional).
Note: the Flow Name
should match one that you've created on the platform.
Create a verification link, or directly upload documents.
You can verify an applicant two ways - by providing them a verification link or directly upload their documents in base64 format.
To generate a verification link, use the Create a Verification Link
action, and enter the Applicant ID you received from the previous step. The verification link allows applicants to upload their documents according to your chosen flow.
No further actions are required for verification when using a verification link, processing starts automatically.
To directly upload documents to an applicant profile, use the Upload a Document
action and enter the required information - such as the Applicant ID, Document Type, Sub Type, Document Country, File Name and the base64 contents.
Once you have uploaded the required documents (front and back side) for your chosen flow, use the Request an Applicant Check
action in order to confirm and start the processing. This is not required if you are using the verification link method - as processing starts automatically.
Note: the file name should include the file extension, for example: id_card.jpg
Additionally, the base64 contents should not include the filetype. For example: /9j/4AAQSkZJRgABAQAAAQABAAD...
For more information on document types and sub types, see our public documentation here: https://documenter.getpostman.com/view/23863579/2s8YzWSLzB#799aec14-d363-4c97-9447-9d20832b75dd
Retrieve an applicant's status and extracted information.
Verifications typically take ~2 minutes to process. To retrieve an applicant's status, use the Retrieve Applicant Status
action with the correlating applicantId.
This action provides an Approved
or Rejected
answer, rejection labels and extracted document information.
Retrieve an applicant's details. (Optional)
Similar to the action above, Retrieve Applicant Details
allows you to retrieve additional information on an applicant, using the correlating applicantId.
Known issues and limitations
Verifications won't proceed if the image is extremely blurry or out-of-focus. We support JPEG, PNG and PDF file types.
Common errors and remedies
When using the Create an Applicant
action, if you receive an error, make sure your Flow Name matches the one that you have created on the platform.
When using the Upload a Document
action to upload a selfie image (if your flow requires), ensure the Document Type is 'SELFIE' and Document SubType is 'NULL'.
FAQ
How is the data of an applicant verified?
Once extracted, applicant data is checked with vetted government and commercial databases including but not limited to electoral roll, vehicle, telco, death and other registries.
What is complex fraud detection or digital manipulation?
Complex fraud detection, or digital manipulation detection, is the process of checking to see if documents have been graphically edited, forged or purchased illegitimately online. This process is run in the background on every verification and helps prevent fraud before it occurs - protecting businesses and individuals.
Are you able to create a custom flow I can use for my business?
Absolutely, each business is unique (and so is every verification). Get in touch with our team, who will be able to create a custom flow tailored to your requirements.
Which countries are supported for a verification?
We verify documents and individuals globally, from drivers licenses to utility bills, bank statements and even correspondence with government authorities - regardless of language or typescript.
Creating a connection
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
Authorization Token | securestring | Enter your Authorization Bearer Token | True |
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Actions
Create Applicant |
Create a new verification applicant. |
Create Verification Link |
Create a verification link to easily upload documents. |
Request Applicant Check |
Confirm all documents are uploaded, and start the check. |
Retrieve Applicant Details |
Retrieve an applicant's details. |
Retrieve Applicant Status |
Retrieve an applicant's verification status and their details. |
Upload Documents to an Applicant |
Upload documents to an applicant with a base64 string. |
Create Applicant
Create a new verification applicant.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Email Address
|
string |
|
||
Phone Number
|
phone | string |
phone |
|
First Name
|
nameFirst | string |
nameFirst |
|
Last Name
|
nameLast | string |
nameLast |
|
Applicant Flow
|
flowName | string |
flowName |
Returns
Name | Path | Type | Description |
---|---|---|---|
status
|
status | string |
status |
applicantId
|
response.applicantId | string |
applicantId |
email
|
response.email | string |
|
phone
|
response.phone | string |
phone |
nameFirst
|
response.nameFirst | string |
nameFirst |
nameLast
|
response.nameLast | string |
nameLast |
flowName
|
response.flowName | string |
flowName |
applicantStatus
|
response.applicantStatus | string |
applicantStatus |
Create Verification Link
Create a verification link to easily upload documents.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Applicant ID
|
applicant | string |
applicant |
Returns
Name | Path | Type | Description |
---|---|---|---|
status
|
status | string |
status |
verificationLink
|
response.verificationLink | string |
verificationLink |
Request Applicant Check
Confirm all documents are uploaded, and start the check.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Applicant ID
|
applicantId | string |
applicantId |
Returns
Retrieve Applicant Details
Retrieve an applicant's details.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Applicant ID
|
applicantId | string |
applicantId |
Returns
Name | Path | Type | Description |
---|---|---|---|
status
|
status | string |
status |
email
|
response.email | string |
|
phone
|
response.phone | string |
phone |
nameFirst
|
response.nameFirst | string |
nameFirst |
nameLast
|
response.nameLast | string |
nameLast |
tags
|
response.tags | array of |
tags |
flowName
|
response.flowName | string |
flowName |
status
|
response.status | string |
status |
Retrieve Applicant Status
Retrieve an applicant's verification status and their details.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Applicant ID
|
applicantId | string |
applicantId |
Returns
Name | Path | Type | Description |
---|---|---|---|
status
|
status | string |
status |
applicantStatus
|
response.applicantStatus | string |
applicantStatus |
applicantActionStatus
|
response.applicantActionStatus | string |
applicantActionStatus |
Modified Date
|
response.result.Modified Date | integer |
Modified Date |
Created Date
|
response.result.Created Date | integer |
Created Date |
Created By
|
response.result.Created By | string |
Created By |
reviewAnswer
|
response.result.reviewAnswer | string |
reviewAnswer |
applicant
|
response.result.applicant | string |
applicant |
commentClient
|
response.result.commentClient | string |
commentClient |
company
|
response.result.company | string |
company |
commentModeration
|
response.result.commentModeration | string |
commentModeration |
rejectLabels
|
response.result.rejectLabels | array of string |
rejectLabels |
reviewRejectType
|
response.result.reviewRejectType | string |
reviewRejectType |
verification
|
response.result.verification | string |
verification |
_id
|
response.result._id | string |
_id |
extractedFirstName
|
response.extractedFirstName | string |
extractedFirstName |
extractedLastName
|
response.extractedLastName | string |
extractedLastName |
extractedBirthDate
|
response.extractedBirthDate | string |
extractedBirthDate |
documentCountry
|
response.documentCountry | string |
documentCountry |
extractedStreetNum
|
response.extractedStreetNum | string |
extractedStreetNum |
extractedStreet
|
response.extractedStreet | string |
extractedStreet |
extractedCity
|
response.extractedCity | string |
extractedCity |
extractedState
|
response.extractedState | string |
extractedState |
extractedPostCode
|
response.extractedPostCode | string |
extractedPostCode |
Upload Documents to an Applicant
Upload documents to an applicant with a base64 string.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Applicant ID
|
applicantId | string |
applicantId |
|
Document Type (eg. ID_CARD)
|
docType | string |
docType |
|
Document Subtype (eg. FRONT_SIDE)
|
docSubType | string |
docSubType |
|
Document Country ISO (eg. AUS)
|
docCountryISO | string |
docCountryISO |
|
File Name + Extension (eg. document.jpeg)
|
filename | string |
filename |
|
File Contents (Base64 string)
|
contents | string |
contents |