Creating an entity

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

This endpoint allows you to create an entity using a chosen flow that you've created within the platform.

Flows allow you to choose what you'd like to screen an entity for, which documents you'd like to request, and whether to verify Ultimate Beneficial Owners (UBOs). For example, a Know Your Business flow you've created may require the entity to provide a certificate of incorporation document and send UBOs a verification link.

If you haven't created a Flow yet, create one by going to https://enterprise.personr.co/dashboard/flows and selecting from one of our templates before proceeding.

To enable entity verification on your account and custom entity flows, please contact your Account Manager.


Create an Entity

POST /api-entity-create

Create an entity, ready to be verified.

NameValue

Content-Type

multipart/form-data

Authorization

Bearer YOUR_TOKEN

Body

NameTypeDescription

companyName

string

The entity's legal name (required)

registrationNumber

string

The entity's registration, or company number (required)

country

string

The entity's country of incorporation (required).

flowName

string

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

(required)

uboFlow

string

The name of the flow you'd like KYC UBOs to be verified on (optional)

Use ISO 3166-1 A3 format for 'country' see here for country codes.

uboFlow is the name of a KYC (Applicant) flow on your account. If you don't want to verify UBOs, leave this blank.

Request

curl --location 'https://enterprise.personr.co/api/1.1/wf/api-entity-create' \
--form 'companyName="Acme Pty Ltd"' \
--form 'registrationNumber="123456789"' \
--form 'country="AUS"' \
--form 'flowName="Know Your Business"' \
--form 'uboFlow="Basic KYC"'

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

Response

{
  "status": "success",
  "response": {
    "applicantId": "4242424242424x424242424242424242",
    "companyName": "Acme Pty Ltd",
    "registrationNumber": "123456789",
    "country": "AUS",
    "flowName": "Know Your Business",
    "applicantStatus": "Created"
  }
}

Last updated