Home

Create a Business Client

POST {{baseurl}}/v2/api/actors

This endpoint allows you to create a business client, also known as a business actor or entity, depending on your nomenclature. This is typically a business entity with which you have a business or commercial relationship.

Header

Name
Type
Description

token*

String

API token

Body

Field
Type
Description

actorType*

String

type of actor "legal_entity".

externalAccountId*

String

external identifier for the client.

customerSegmentation*

String[]

Array of strings of actor category based on business customer segmentation.

accountNumbers*

Object[]

array of account numbers belonging to the actor.

accountType*

String

type of account.

accountNumber*

String

account number.

domicile

String

country code where account is domiciled.

accountCreationDate*

String

Date account number was created.

phones

Object[]

Array of phone numbers belonging to the actor.

numberType

String

type of the phone number "office".

countryCode*

String

country code.

phone*

String

phone number.

socials

Object[]

Array of social media accounts belonging to the actor.

type

String

social media platform of the social account.

handle

String

social media handle of the social account.

emails

Object[]

Array of email addresses belonging to the actor.

emailType

String

type of the email account "office".

address

String

address of the email account.

idType*

String

Type of ID.

value*

String

number of ID.

issuingAuthority

String

organisation issuing the ID.

expirationDate

String

Date the ID expires.

addresses*

Object[]

Array of addresses belonging to the actor.

addressType

String

type of the address "office".

line1*

String

address line 1

line2

String

address line 2

postCode*

String

post/zip code

city*

String

address city

state*

String

address state/province

country*

String

address country

lengthOfStay*

String

length of stay in address in months

legalEntity*

Object

details of incorporation if the actor is a legal entity.

dateOfRegistration

String

Date of registration of business

type*

String

type of business entity

registrationNumber*

String

business registration number

industryClassification*

String

industry of business

url

String

website url of business

countryOfIncorporation

String

country of Incorporation of business

legalEntityDirectors*

Object[]

details of directors of the business at least one director is required.

name*

String

name of director

sourceOfIncome*

String

source of income of director

industry*

String

industry of director

phoneNumbers*

Object[]

Array of phone numbers belonging to director

countryCode*

String

country code

phone*

String

phone number

emails*

String[]

Array of emails belonging to director

uniqueIdentifier*

Object[]

ID of director

issuingCountry*

String

Issuing Country of ID

idType*

String

type of ID

idNumber*

String

Number of ID

kycVerifiedBy*

String

KYC verified By one of youverify - if KYC was verified by youverify, client - if KYC was verified by client, not_verified - if KYC has not been verified

verificationId

String

youverify KYC verification ID - if KYC was verified by youverify

{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}
PreviousCreate an Individual ClientNextInitiaite an Individual Client Assessment

Last updated