Create a Business Client

POST {{baseurl}}/v2/api/actor

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

Name

Type

Description

token*

String

API token

Body

Name Type Description

Name	Type	Description
actorType*	String	type of customer: `"legal_entity"`
sourceOfIncome	String	The source of income of the actor: `Not required`
industry	String	The industry of the actor's occupation: `Not required`
customerSegmentation	String[]	An array of strings of actor categories based on the business customer segmentation. This can be: `high_risk, low_risk, medium_risk, high_net_worth, high_income`
accountNumbers*	Object[]	An array of account numbers that belong to the actor: `applies for both entity types`
accountType*	String	The type of account. It can be: `savings,current,corporate`
accountNumber*	String	The account number
domicile	String	The country code where the account is domiciled. This is the ISO alpha-2 country code: `US`
accountCreationDate*	String	The date the account number was created. This is represented using the JIS format `YYYY-MM-DD`
phones	Object[]	An array of phone numbers belonging to the actor: `Not required`
numberType	String	The type of phone number: `can be "personal" or "office"`
countryCode*	String	This is the international dialling code of the corresponding country. US:`1`
phone*	String	The phone number: `07100000000`
socials	Object[]	The array of social media accounts belonging to the actor: `applies for both entity types`
type	String	The social media platform of the social account
handle	String	The social media handle of the social account
emails	Object[]	The array of email addresses belonging to the actor: `Not required`
emailType	String	The type of email account: `can be, "personal" or "office"`
address	String	The address of the email account
addresses*	Object[]	The array of addresses belonging to the actor: `requires for both entity types`
addressType	String	The type of address: can be "home" or "office"
line1*	String	Address line 1
line2	String	Address line 2
postCode*	String	post/zip code of the address
city*	String	Address city
state*	String	Address state/province
country*	String	address country
lengthOfStay*	String	The length of stay at the address: `in months`
legalEntity*	Object	the details of the incorporation: `required`
dateOfRegistration	String	The date the business was registered. This is represented using the JIS format `YYYY-MM-DD`
type*	String	The type of business entity. This can be a: `limited_liability, sole_proprietorship, general_partnership, limited_partnership, corp, non_profit, co_op`
registrationNumber*	String	The business registration number
industryClasssification*	String	The industry of the business
url	String	The website URL of the business
countryOfIncorporation	String	The country the business was incorporated. This is the ISO alpha-2 country code: `US`
legalEntityDirectors*	Object[]	The details of the directors of the business: `at least one director is required`
name*	String	The name of the director. This is represented as: `first_name and last_name`
sourceOfIncome*	String	The source of income of the director. This can be: `earned income, investment income, interest and dividend income, rental income, business income, capital gains, retirement income, self-employment, royalty and intellectual property income, others`
industry*	String	The industry of the director
phoneNumbers*	Object[]	The array of phone numbers belonging to the director
countryCode*	String	The country code of the phone number. This is the ISO alpha-2 country code: `US`
phone*	String	The phone number of the director
emails*	String[]	The array of emails belonging to the director
uniqueIdentifier*	Object[]	The ID of the director
idType*	String	The type of ID
idNumber*	String	The number of the ID
kycVerifiedBy*	String	The KYC was done 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 the KYC was done by youverify`

actorType*

String

type of customer: "legal_entity"

sourceOfIncome

String

The source of income of the actor: Not required

industry

String

The industry of the actor's occupation: Not required

customerSegmentation

String[]

An array of strings of actor categories based on the business customer segmentation. This can be: high_risk, low_risk, medium_risk, high_net_worth, high_income

accountNumbers*

Object[]

An array of account numbers that belong to the actor: applies for both entity types

accountType*

String

The type of account. It can be: savings,current,corporate

accountNumber*

String

The account number

domicile

String

The country code where the account is domiciled. This is the ISO alpha-2 country code: US

accountCreationDate*

String

The date the account number was created. This is represented using the JIS format YYYY-MM-DD

phones

Object[]

An array of phone numbers belonging to the actor: Not required

numberType

String

The type of phone number: can be "personal" or "office"

countryCode*

String

This is the international dialling code of the corresponding country. US:1

phone*

String

The phone number: 07100000000

socials

Object[]

The array of social media accounts belonging to the actor: applies for both entity types

type

String

The social media platform of the social account

handle

String

The social media handle of the social account

emails

Object[]

The array of email addresses belonging to the actor: Not required

emailType

String

The type of email account: can be, "personal" or "office"

address

String

The address of the email account

addresses*

Object[]

The array of addresses belonging to the actor: requires for both entity types

addressType

String

The type of address: can be "home" or "office"

line1*

String

Address line 1

line2

String

Address line 2

postCode*

String

post/zip code of the address

city*

String

Address city

state*

String

Address state/province

country*

String

address country

lengthOfStay*

String

The length of stay at the address: in months

legalEntity*

Object

the details of the incorporation: required

dateOfRegistration

String

The date the business was registered. This is represented using the JIS format YYYY-MM-DD

type*

String

The type of business entity. This can be a: limited_liability, sole_proprietorship, general_partnership, limited_partnership, corp, non_profit, co_op

registrationNumber*

String

The business registration number

industryClasssification*

String

The industry of the business

url

String

The website URL of the business

countryOfIncorporation

String

The country the business was incorporated. This is the ISO alpha-2 country code: US

legalEntityDirectors*

Object[]

The details of the directors of the business: at least one director is required

name*

String

The name of the director. This is represented as: first_name and last_name

sourceOfIncome*

String

The source of income of the director. This can be: earned income, investment income, interest and dividend income, rental income, business income, capital gains, retirement income, self-employment, royalty and intellectual property income, others

industry*

String

The industry of the director

phoneNumbers*

Object[]

The array of phone numbers belonging to the director

countryCode*

String

The country code of the phone number. This is the ISO alpha-2 country code: US

phone*

String

The phone number of the director

emails*

String[]

The array of emails belonging to the director

uniqueIdentifier*

Object[]

The ID of the director

idType*

String

The type of ID

idNumber*

String

The number of the ID

kycVerifiedBy*

String

The KYC was done 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 the KYC was done by youverify

{
        "actorType": "legal_entity",
        "businessName": "hewlett packard",
        "customerSegmentation": ["business clients", "high profile"],
        "KycVerifiedBy": "youverify",
        "verificationId": "642eb06f0d84552686540c36",
        "accountNumbers": [
                      {
                       "accountType": "personal",
                       "accountNumber": "00000000000",
                       "domicile": "US",
                       "accountCreationDate": "2013-09-09"
                      }
                  ],
        "phones": [
                     {
                       "numberType": "office",
                       "phone": "00000000000"
                     }
                 ],
        "socials": [
                     {
                       "type": "twitter",
                       "handle": "john_doe"
                     }
                 ],
        "emails": [
                     {
                       "emailType": "personal",
                       "address": "johndoe@gmail.com"
                     }
                 ],
        "governmentIds": [
                     {
                       "idType": "ein",
                       "value": "111111111",
                       "issuingAuthority": "irs",
                       "expirationDate": "2024-05-20",
                     }
                 ],
       "addresses": [
                     {
                       "addressType": "office",
                       "line1": "39 Wellsfargo",
                       "line2": "apt 8",
                       "postCode": "22222223",
                       "city": "Ferry heights",
                       "state": "New York",
                       "country": "US",
                       "lengthOfStay": "15"
                     }
                 ],
      "legalEntity": {
                       "dateOfRegistration": "1978-06-24",
                       "type": "limited liability ",
                       "url": "www.youverify.co",
                       "industryClassification": "fintech",
                       "registrationNumber": "93067940",
                       "countryOfIncoporation": "US"
                     },
      "legalEntityDirectors": [
                     {
                       "name": "John Doe",
                       "sourceOfIncome": "rental income",
                       "phoneNumbers": [
                                  {
                                      "countryCode": "1", 
                                      "phone": "0000000000"
                                  }
                              ],
                       "emails": ["johndoe@email.com"],
                       "uniqueIdentifier": {
                           "type": "SSN",
                           "idNumber": "111111111"
                       }
                     }
                 ]
       
      }

{
    "success": true,
    "statusCode": 201,
    "message": "Actor created successfully!",
    "data": {
        "parentId": "628b38f03ae28a14f52d4bf7",
        "isDeleted": false,
        "businessId": "6401c96e055bc4df85ac7753",
        "actorType": "legal_entity",
        "businessName": "hewlett packard",
        "KycVerifiedBy": "youverify",
        "verificationId": "642eb06f0d84552686540c36",
        "customerSegmentation": ["business clients", "high profile"],
        "accountNumbers": [
            {
                "_id": "642eb1260d845561cd540c3d",
                "accountType": "personal",
                "accountNumber": "00000000000",
                "domicile": "US",
                "accountCreationDate": "2013-09-09"
            }
        ],
        "phones": [
            {
                "_id": "642eb1260d845515ae540c3e",
                "numberType": "office",
                "phone": "00000000000"
            }
        ],
        "socials": [
            {
                "_id": "642eb1260d8455b6cf540c3f",
                "type": "twitter",
                "handle": "john_doe"
            }
        ],
        "emails": [
            {
                "_id": "642eb1260d8455108a540c40",
                "emailType": "personal",
                "address": "johndoe@email.com"
            }
        ],
        "governmentIds": [
            {
                "_id": "642eb1260d8455c6c7540c41",
                "idType": "ein",
                "value": "11111111111",
                "issuingAuthority": "irs",
                "expirationDate": "20th may, 2024",
            }
        ],
        "addresses": [
            {
                "_id": "642eb1260d8455712f540c42",
                "addressType": "office",
                "line1": "39 Wellsfargo",
                "line2": "apt 8",
                "postCode": "22222223",
                "city": "Ferry heights",
                "state": "New York",
                "country": "US",
                "lengthOfStay": "20",
                "dateAdded": "2023-04-06T11:46:46.898Z",
                "lastModifiedAt": "2023-04-06T11:46:46.898Z"
            }
        ],
        "legalEntity": {
            "_id": "642eb1260d8455c872540c43",
            "dateOfRegistration": "Sat Jun 24 1978 00:00:00 GMT+0000 (Coordinated Universal Time)",
            "type": "limited liability ",
            "url": "www.youverify.co",
            "industryClassification": "fintech",
            "registrationNumber": "93067940",
            "countryOfIncoporation": "US"
        },
        "legalEntityDirectors": [
            {
                "phoneNumbers": [
                       {
                            "countryCode": "1", 
                            "phone": "0000000000"
                        }            
                    ],
                "emails": [
                    "johndoe@email.com"
                ],
                "_id": "642eb1260d8455d385540c44",
                "name": "John Doe",
                "sourceOfIncome": "rental income",
                "uniqueIdentifier": {
                    "type": "SSN",
                    "idNumber": "111111111"
                }
            }
        ],
        "createdAt": "2023-04-06T11:46:46.899Z",
        "lastModifiedAt": "2023-04-06T11:46:46.899Z",
        "_createdAt": "2023-04-06T11:46:4646+00:00",
        "_lastModifiedAt": "2023-04-06T11:46:4646+00:00",
        "id": "642eb1260d84550a5e540c3c"
    },
    "links": []
   }

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

PreviousCreate an Individual Client NextUpdate a Client

Last updated 29 days ago