LogoLogo
Home
  • Youverify API Documentation
  • Getting Started
    • Getting your API Key
    • Getting your Public Merchant Key
    • Environment
    • Response Codes
  • Know Your Customer Services (KYC)
    • ID Document Verification (SDK)
      • Web SDK
      • iOS SDK
        • iOS Liveness SDK
        • iOS (Compat) Liveness SDK
        • iOS Document Capture SDK
      • Android SDK
        • Android Document Capture SDK
        • Android Liveness SDK
      • Document Capture Supported Countries
        • 🌏Asia
        • πŸ‡ͺπŸ‡ΊEurope
        • 🌎Latin America and the Caribbean
        • 🌍Middle East and Africa
        • 🌎North America
        • 🌏Oceania
    • ID Data Matching (eIDV)
      • 🌐Global
        • Supported Countries
      • πŸ‡ΏπŸ‡¦South Africa
        • Verify South African ID Number (SAID)
        • Verify South African Phone Number
        • Bank Account Verification
        • Proof of Address Verification
      • πŸ‡°πŸ‡ͺKenya
        • Verify International Passport
        • Verify Alien ID
        • Verify Drivers License
        • Verify Plate Number
        • Verify Collateral ID
        • Kenyan Bank Account Verification
          • Bank List
        • Credit History
        • Employment History
        • Verify Address Information
        • Verify Phone Number
        • Verify Identity Number
        • Verify Tax PIN
      • πŸ‡¬πŸ‡­Ghana
        • Verify International Passport
        • Verify Social Security and National Insurance Trust (SSNIT)
        • Verify Ghana Voters Card (GVC)
      • πŸ‡³πŸ‡¬Nigeria
        • Verify Bank Verification Number (BVN)
        • Verify Bank Verification Number (BVN Premium)
        • Verify Virtual National Identification Number (vNIN)
        • Verify National Identification Number (NIN)
        • Verify Nigerian Driver's License (Driver's License)
        • Advanced Phone Search
        • Verify Nigerian International Passport (Passport)
        • Verify Nigerian Permanent Voters Card (PVC)
        • Verify Phone Number
        • Individual Credit Report
        • Bank Account Verification
          • Basic Bank Account Verification
          • Bank List
            • Getting the list of Banks for Basic Bank Account
    • Facial Comparison
    • Retrieve an Identity
    • Identity History
  • Know Your Business Services (KYB)
    • 🌍Business Verification
    • 🌍Search for Businesses
    • Get Supported Countries and Regions
    • Retrieve Business details
    • Country-Specific KYB Services
      • πŸ‡³πŸ‡¬Nigeria
        • Tax Identification Number (TIN) Verification
      • πŸ‡ΏπŸ‡¦South Africa
        • Business Account Verification
        • Business Address Verification
  • Know Your Transaction Service (KYT)
    • Customer Management
      • Create an Individual Client
      • Create a Business Client
      • Initiate an Individual Client Assessment
      • Initiate an Business Client Assessment
      • Update a Client
      • Retrieve all Clients
      • Retrieve a Client
      • Delete a Client
    • Transaction Management
      • Create a Transaction
      • Retrieve an Evaluation
  • Risk Intelligence
    • Risk Intelligence: Initialise Risk Check
    • Retrieve Risk Intelligence Profile
    • Retrieve Risk Intelligence History
  • AML Services (Anti-Money Laundering)
    • PEP and Sanction Screening
      • Search using Name
        • Advanced Filters
      • Search using Identity
        • Advanced Filters
      • Search using Crypto
        • Advanced Filters
      • Retrieve a PEP and Sanction Screening Search
      • Screening Data Sources
      • Domestic PEP Search
    • Adverse Media Intelligence
    • Custom AML Watchlist
      • AML Watchlist (Sample list)
      • AML Watchlist Upload (Bulk Upload)
      • AML Watchlist Upload
      • Retrieve AML Watchlist
      • AML Watchlist Entity Update
      • AML Watchlist Entity Removal
  • Custom Workflow Builder (CWB)
    • CWB Webhook
    • CWB External API
      • Retrieve CWB History
      • Retrieve CWB Responses
      • Retrieve CWB Report
  • Youverify OS Error Codes
  • Webhooks
    • Know Your Customer Webhooks
      • Identity Verification
      • Address Verification
    • Know Your Transaction Webhooks
      • Customer Management Webhooks
        • Client Created
        • Client Updated
      • Alert Service Webhooks
        • Alert Created
        • Alert Triage Created
        • Alert Updated
      • Evaluation Webhooks
        • Evaluation Completed
        • Evaluation Started
        • Transaction Updated
  • Test Data
  • Our Legacy API and SDK
Powered by GitBook
On this page
  • Header
  • Body

Was this helpful?

  1. Know Your Transaction Service (KYT)
  2. Customer Management

Create a Business Client

POST {{baseurl}}/v1/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

{
        "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": "tin",
                       "value": "11111111111",
                       "issuingAuthority": "firs",
                       "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": "RC0593067940",
                       "countryOfIncoporation": "US"
                     },
      "legalEntityDirectors": [
                     {
                       "name": "Olu Vichai",
                       "sourceOfIncome": "rental income",
                       "phoneNumbers": [
                                  {
                                      "countryCode": "234", 
                                      "phone": "0000000000"
                                  }
                              ],
                       "emails": ["olureal@gmail.com"],
                       "uniqueIdentifier": {
                           "type": "bvn",
                           "idNumber": "000000000"
                       }
                     }
                 ]
       
}
{
    "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@gmail.com"
            }
        ],
        "governmentIds": [
            {
                "_id": "642eb1260d8455c6c7540c41",
                "idType": "tin",
                "value": "11111111111",
                "issuingAuthority": "firs",
                "expirationDate": "2025-04-21",
            }
        ],
        "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": "RC0593067940",
            "countryOfIncoporation": "US"
        },
        "legalEntityDirectors": [
            {
                "phoneNumbers": [
                       {
                            "countryCode": "234", 
                            "phone": "0000000000"
                        }            
                    ],
                "emails": [
                    "olureal@gmail.com"
                ],
                "_id": "642eb1260d8455d385540c44",
                "name": "Olu Vichai",
                "sourceOfIncome": "rental income",
                "uniqueIdentifier": {
                    "type": "bvn",
                    "idNumber": "000000000"
                }
            }
        ],
        "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 ClientNextInitiate an Individual Client Assessment

Last updated 4 months ago

Was this helpful?