For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get all Entity

This endpoint allows you to retrieve all existing entities, this can either be a business or an individual.

GET {{baseurl}}/v2/api/entities

Headers

Name
Type
Description

token*

String

API secret token

Parameter

Field
Type
Description

sortField

String

Field to sort by

sortOrder

String

Sort order, either 'asc' or 'desc', sortField must be set for this to take effect

searchTerm

String

Search query

limit

Number

number of logs to return

Default value: 20

startDate

String

start date

endDate

String

end date

status

String

comma separated list of statuses

entityType

String

type of entity (individual or business)

businessIds

String

Admin use only(comma separated list of business IDs)

countryCodes

String

a comma separated list of country codes

isUBO

Boolean

whether the entity is a UBO (Ultimate Beneficial Owner)

 {
    "success": true,
    "statusCode": 200,
    "message": "Entities fetched successfully!",
    "data": {
          "docs": [
            {
                "_id": "685c87dfe1d184f2663b4e41",
                "businessId": "61d880f1e8e15aaf24558f1a",
                "entityType": "business",
                "incorporationNumber": "RC00000002",
                "incorporationName": "Kord Industries",
                "incorporationDate": "2019-06-09",
                "address": "Somewhere on palmeras city",
                "businessType": "Corporate Equity",
                "taxId": null,
                "status": "not_approved",
                "profileStatus": "pending",
                "incorporationCountry": "NG",
                "createdBy": "61f162ec1fd251c3a63f31c2",
                "isOnboarded": true,
                "potentialEntityMatch": null,
                "createdAt": "2025-06-25T23:35:59.293Z",
                "lastModifiedAt": "2025-06-25T23:35:59.293Z",
                "_createdAt": "2025-06-26T00:35:5959+01:00",
                "_lastModifiedAt": "2025-06-26T00:35:5959+01:00",
                "object": "entity",
                "id": "ent_685c87dfe1d184f2663b4e41"
            },
            {
               "businessId": "61d880f1e8e15aaf24558f1a",
                "id": "ent_68ae3859d82e350f82fd9e95",
                "firstName": "Sarah",
                "lastName": "Doe",
                "middleName": "Jane",
                "entityType": "individual",
                "gender": "female",
                "taxId": null,
                "status": "created",
                "profileStatus": "pending",
                "isOnboarded": true,
                "dateOfBirth": "1988-04-04",
                "createdAt": "2025-08-26T22:42:33.879Z",
                "lastModifiedAt": "2025-08-26T22:42:37.860Z",
                "createdBy": "61f162ec1fd251c3a63f31c2",
                "_id": "68ae3859d82e350f82fd9e95",
                "object": "entity",
            }
        ],
        "pagination": {
            "type": "cursor",
            "perPage": 20,
            "nextPage": "685c7479519d82bd21a42fba",
            "prevPage": null,
            "hasNextPage": true,
            "hasPrevPage": false
        },
        "searchTerms": {}
  },
    "links": []
}

Last updated

Was this helpful?