Create an Individual Client

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

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

Header

Name	Type	Description
token*	String	API token

Body

Name	Type	Description
actortype*	String	type of customer: "individual"
firstName*	String	First name of the actor
lastName*	String	Last name of the actor
middleName	String	Middle name of the actor
gender	String	The gender of the actor. This can be either male or female
nationality	String	The nationality type of the actor. This is the ISO alpha-2 country code: US
sourceOfIncome	String	The source of income of the actor. 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
occupation	String	The occupation of the actor
industry*	String	The industry of the actor's occupation. This can be:
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
dateOfBirth	String	The date of birth of the actor: This is represented using the JIS format YYYY-MM-DD
accountNumbers*	Object[]	An array of account numbers that belong to the actor:
accountType*	String	The type of account. It can be: savings,current
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
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
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
emailType	String	The type of email account: can be, "personal" or "office"
address	String	The address of the email account
governmentIds*	Object[]	The array of government IDs belonging to the actor
idType*	String	Type of ID
value*	String	The ID number
issuingAuthority	String	The organisation issuing the ID
expirationDate	String	The date the ID expires. This is represented using the JIS format YYYY-MM-DD
addresses*	Object[]	The array of addresses belonging to the actor
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. This is the ISO alpha-2 country code: US
lengthOfStay*	String	The length of stay at the address: in months
countryCode	String	The country code of the phone number. This is the ISO alpha-2 country code: US
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

Sample Request for Individuals

{
      "actorType": "individual",
      "firstName": "John",
      "lastName": "Doe",
      "middleName": "Smith",
      "dateOfBirth": "1985-03-05",
      "nationality": "US",
      "gender": "male",
      "sourceOfIncome": "business",
      "occupation": "product manager",
      "industry": "technology",
      "KycVerifiedBy": "Cisco",
      "verificationId": "642eb06f0d84552686540c36",
      "uniqueIdentifier": {
        "type": "SSN",
        "idNumber": "000000000"
        },
      "customerSegmentation": ["tech talents", "high profile"],
      "accountNumbers": [
                    {
                     "accountType": "savings",
                     "accountNumber": "00000000000",
                     "domicile": "US",
                     "accountCreationDate": "2013-09-09"
                    }
                ],
      "phones": [
                   {
                     "numberType": "personal",
                     "phone": "0000000000",
                     "countryCode": "1"
                   },
                   {
                     "numberType": "office",
                     "phone": "00000000000"
                   }
               ],
      "socials": [
                   {
                     "type": "twitter",
                     "handle": "john_doe"
                   },
                   {
                     "type": "instagram",
                     "handle": "prettyJohn"
                   }
               ],
      "emails": [
                   {
                     "emailType": "personal",
                     "address": "[e-mail]"
                   }
               ],
      "governmentIds": [
                   {
                     "idType": "SSN",
                     "value": "111111111",
                     "issuingAuthority": "SSA",
                     "expirationDate": "2024-05-24",
                   }
               ],
     "addresses": [
                   {
                     "addressType": "home",
                     "line1": "35 Wellsfargo",
                     "line2": "apt 3",
                     "postCode": "2222222",
                     "city": "garden heights",
                     "state": "New York",
                     "country": "US",
                     "lengthOfStay": "20"
                   }
               ]
     
    }

Success Response for Individual

{
"success": true,
"statusCode": 201,
"message": "Actor created successfully!",
"data": {
    "parentId": null,
    "isDeleted": false,
    "businessId": "628b38f03ae28a14f52d4bf7",
    "actorType": "individual",
    "firstName": "John",
    "lastName": "M",
    "middleName": "Doe",
    "dateOfBirth": "Tue Mar 05 1985 00:00:00 GMT+0000 (Coordinated Universal Time)",
    "sourceOfIncome": "business",
    "occupation": "product manager",
    "industry": "technology",
    "customerSegmentation": ["tech talents", "high profile"],
    "nationality": "US",
    "gender": "male",
    "KycVerifiedBy": "youverify",
    "verificationId": "642eb06f0d84552686540c36",
    "uniqueIdentifier": {
        "type": "SSN",
        "idNumber": "111111111"
    },
    "accountNumbers": [
        {
            "_id": "642eb06f0d8455d0d0540c2f",
            "accountType": "savings",
            "accountNumber": "00000000000",
            "domicile": "US",
            "accountCreationDate": "2013-09-09"
        }
    ],
    "phones": [
        {
            "_id": "642eb06f0d8455210f540c30",
            "numberType": "personal",
            "phone": "0000000000",
            "countryCode": "1"
        },
        {
            "_id": "642eb06f0d8455964a540c31",
            "numberType": "office",
            "phone": "0000000000"
        }
    ],
    "socials": [
        {
            "_id": "642eb06f0d8455652c540c32",
            "type": "twitter",
            "handle": "john_doe"
        },
        {
            "_id": "642eb06f0d8455f043540c33",
            "type": "instagram",
            "handle": "prettyJohn"
        }
    ],
    "emails": [
        {
            "_id": "642eb06f0d8455f762540c34",
            "emailType": "personal",
            "address": "[e-mail]"
        }
    ],
    "governmentIds": [
        {
            "_id": "642eb06f0d84555d43540c35",
            "idType": "SSN",
            "value": "11111111111",
            "issuingAuthority": "SSA",
            "expirationDate": "20th may, 2024",
        }
    ],
    "addresses": [
        {
            "_id": "642eb06f0d84552686540c36",
            "addressType": "home",
            "line1": "35 Wellsfargo",
            "line2": "apt 3",
            "postCode": "2222222",
            "city": "garden heights",
            "state": "New York",
            "country": "US",
            "lengthOfStay": "15",
            "dateAdded": "2023-04-06T11:43:43.507Z",
            "lastModifiedAt": "2023-04-06T11:43:43.507Z"
        }
    ],
    "createdAt": "2023-04-06T11:43:43.508Z",
    "lastModifiedAt": "2023-04-06T11:43:43.508Z",
    "_createdAt": "2023-04-06T11:43:4343+00:00",
    "_lastModifiedAt": "2023-04-06T11:43:4343+00:00",
    "id": "642eb06f0d84555c0f540c2e"
},
"links": []
}

Error Response

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