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 an Individual Client

POST {{baseurl}}/v1/api/actors

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

Field
Type
Description

actorType*

String

type of actor one of "individual" or "legal_entity".

externalAccountId*

String

external identifier for the client.

firstName*

String

first name of the actor required, if actorType is individual.

lastName*

String

last name of the actor required, if actorType is individual.

middleName

String

middle name of the actor applies, if actorType is individual.

gender

String

gender of the actor applies, if actorType is individual.

nationality

String

nationality of the actor applies, if actorType is individual.

sourceOfIncome

String

source of income of the actor applies, if actorType is individual.

occupation

String

occupation of the actor applies, if actorType is individual.

industry*

String

industry of the actor's occupation required, if actorType is individual.

customerSegmentation*

String[]

Array of strings of actor category based on business customer segmentation applies, for both types.

dateOfBirth

String

date of birth of the actor applies, if actorType is individual.

accountNumbers*

Object[]

array of account numbers belonging to the actor required, for both types.

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 actorrequired, if actorType is individual.

numberType

String

type of the phone number can be, "personal" or "office".

countryCode*

String

country code.

phone*

String

phone number.

socials

Object[]

Array of social media accounts belonging to the actor applies, for both types.

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 required, if actorType is individual.

emailType

String

type of the email account can be, "personal" or "office".

address

String

address of the email account.

governmentIds*

Object[]

Array of government Ids belonging to the actor required, if actorType is individual.

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 required, for both types.

addressType

String

type of the address can be, "home" or "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 required, if actorType is 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, if actorType is legal_entity.

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": "individual",
      "firstName": "Confidence",
      "lastName": "Sunday",
      "middleName": "Mogaji",
      "dateOfBirth": "1985-03-05",
      "nationality": "NG",
      "gender": "male",
      "sourceOfIncome": "business",
      "occupation": "product manager",
      "industry": "technology",
      "KycVerifiedBy": "youverify",
      "verificationId": "642eb06f0d84552686540c36",
      "uniqueIdentifier": {
        "type": "bvn",
        "idNumber": "000000000"
        },
      "customerSegmentation": ["tech talents", "high profile"],
      "accountNumbers": [
                    {
                     "accountType": "savings",
                     "accountNumber": "00000000000",
                     "domicile": "NG",
                     "accountCreationDate": "2013-09-09"
                    }
                ],
      "phones": [
                   {
                     "numberType": "personal",
                     "phone": "00000000000",
                     "countryCode": "234"
                   },
                   {
                     "numberType": "office",
                     "phone": "00000000000"
                   }
               ],
      "socials": [
                   {
                     "type": "twitter",
                     "handle": "john_doe"
                   },
                   {
                     "type": "instagram",
                     "handle": "prettyJohn"
                   }
               ],
      "emails": [
                   {
                     "emailType": "personal",
                     "address": "johndoe@gmail.com"
                   }
               ],
      "governmentIds": [
                   {
                     "idType": "nin",
                     "value": "11111111111",
                     "issuingAuthority": "nimc",
                     "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": true,
"statusCode": 201,
"message": "Actor created successfully!",
"data": {
    "parentId": null,
    "isDeleted": false,
    "businessId": "628b38f03ae28a14f52d4bf7",
    "actorType": "individual",
    "firstName": "Confidence",
    "lastName": "Sunday",
    "middleName": "Mogaji",
    "dateOfBirth": "1985-04-21",
    "sourceOfIncome": "business",
    "occupation": "product manager",
    "industry": "technology",
    "customerSegmentation": ["tech talents", "high profile"],
    "nationality": "NG",
    "gender": "male",
    "KycVerifiedBy": "youverify",
    "verificationId": "642eb06f0d84552686540c36",
    "uniqueIdentifier": {
        "type": "bvn",
        "idNumber": "000000000"
    },
    "accountNumbers": [
        {
            "_id": "642eb06f0d8455d0d0540c2f",
            "accountType": "savings",
            "accountNumber": "00000000000",
            "domicile": "NG",
            "accountCreationDate": "2013-09-09"
        }
    ],
    "phones": [
        {
            "_id": "642eb06f0d8455210f540c30",
            "numberType": "personal",
            "phone": "00000000000",
            "countryCode": "234"
        },
        {
            "_id": "642eb06f0d8455964a540c31",
            "numberType": "office",
            "phone": "00000000000"
        }
    ],
    "socials": [
        {
            "_id": "642eb06f0d8455652c540c32",
            "type": "twitter",
            "handle": "john_doe"
        },
        {
            "_id": "642eb06f0d8455f043540c33",
            "type": "instagram",
            "handle": "prettyJohn"
        }
    ],
    "emails": [
        {
            "_id": "642eb06f0d8455f762540c34",
            "emailType": "personal",
            "address": "johndoe@gmail.com"
        }
    ],
    "governmentIds": [
        {
            "_id": "642eb06f0d84555d43540c35",
            "idType": "nin",
            "value": "11111111111",
            "issuingAuthority": "nimc",
            "expirationDate": "2025-04-21",
        }
    ],
    "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": []
}

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

Last updated 2 months ago

Was this helpful?