Retrieve a Client

GET {{baseurl}}/v2/api/actors/:actorId

This endpoint allows you to retrieve a client.

Header

Name	Type	Description
token*	String	API token

Body

Name	Type	Description
actorId	String	ID of the actor record in database

Success Response

{
"success": true,
"statusCode": 200,
"message": "Actor retrieved successfully!",
"data": {
    "parentId": null,
    "isDeleted": false,
    "businessId": "628b38f03ae28a14f52d4bf7",
    "actorType": "individual",
    "firstName": "Confidence",
    "lastName": "Sunday",
    "middleName": "Mogaji",
    "dateOfBirth": "1985-04-21",
    "nationality": "NG",
    "gender": "male",
    "sourceOfIncome": "business",
    "occupation": "product manager",
    "industry": "technology",
    "KycVerifiedBy": "youverify",
    "verificationId": "642eb06f0d84552686540c36",
    "customerSegmentation": ["tech talents", "high profile"],
    "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": "[e-mail]"
        }
    ],
    "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": "20",
            "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": {}
}