Creating an applicant

Let's create an applicant, ready to be verified.

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.


Create an applicant

POST /api-applicant-create

Create an applicant, ready to be verified.

NameValue

Content-Type

multipart/form-data

Authorization

Bearer YOUR_TOKEN

Body

NameTypeDescription

email

string

The applicant's email address (required)

phone

string

The applicant's phone number (required)

nameFirst

string

The applicant's first name (optional)

nameLast

string

The applicant's last name (optional)

flowName

string

The name of the flow you'd like the applicant to go through

(required)

Request

curl --location 'https://enterprise.personr.co/api/1.1/wf/api-applicant-create' \
--form 'email="johndoe@mail.com"' \
--form 'phone="+61 424 424 424"' \
--form 'nameFirst="John"' \
--form 'nameLast="Doe"' \
--form 'flowName="KYC basic"'

Response

{
  "status": "success",
  "response": {
    "applicantId": "4242424242424x424242424242424242",
    "email": "johndoe@mail.com",
    "phone": "+61 424 424 424",
    "nameFirst": "John",
    "nameLast": "Doe",
    "flowName": "KYC basic",
    "applicantStatus": "Created"
  }
}

Remember to input the flow name exactly as you created it. Don't use the template name.

Last updated