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
Body
{
"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": {}
}Last updated