Retrieve all Clients

GET {{baseurl}}/v1/api/actors

This endpoint allows you to retrieve all clients.

Header

Name	Type	Description
token*	String	API token

Body

Name	Type	Description
page	Number	The current page to return. Default value: 1
limit	Number	Number of documents to return per page. Default value: 20
name	String	Search for a customer by name
idName	String	Search for a customer using a unique identifier
idNumber	String	Search for a customer using a unique identifier
actorType	String	Filters actors by actor type
riskStatus	String	Filter actors by risk status
organisationId	String	Get all organisation's actors: Applies only to YVOS business accounts
startDate	String	Start date of the alerts.
endDate	String	End date of the alerts
registrationNumber	Number	Search for actors by registration number

Success Response

{
"success": true,
"statusCode": 200,
"message": "Actors retrieved successfully!",
"data": {
        "docs": [
                {
                    "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"
                        },
                        {
                            "_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": "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"
                }
            ],
    "pagination": {
        "totalDocs": 1,
        "perPage": 20,
        "totalPages": 1,
        "currentPage": 1,
        "serialNo": 1,
        "hasPrevPage": false,
        "hasNextPage": false,
        "prevPage": null,
        "nextPage": null
    }
},
"links": []
}

Error Response

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