Creating an applicant
Let's create an applicant, ready to be verified.
Last updated
Let's create an applicant, ready to be verified.
Last updated
This endpoint allows you to create an applicant on a chosen flow that you've created within the platform.
Flows allow you to choose what you'd like to screen an applicant for, and which documents you'd like verified. For example, a basic flow you've created may require the applicant to provide one identity document and go through a selfie check.
If you haven't created a Flow yet, create one by going to https://enterprise.personr.co/dashboard/flows before proceeding.
POST
/api-applicant-create
Create an applicant, ready to be verified.
Name | Value |
---|---|
Content-Type |
|
Authorization |
|
Body
Name | Type | Description |
---|---|---|
| string | The applicant's email address (required) |
| string | The applicant's phone number (required) |
| string | The applicant's first name (optional) |
| string | The applicant's last name (optional) |
| string | The name of the flow you'd like the applicant to go through (required) |
| string | An internal unique identifier, or source, that you can use to identify where the entity came from, which is returned in all responses (optional) |
| list | External identifiers that are returned in all responses (optional) |
Response
Remember to input the flow name exactly as you created it. Don't use the template name.