Skip to main content
GET
/
kyb
/
companies
List companies
curl --request GET \
  --url https://api.example.com/kyb/companies/ \
  --header 'Authorization: Basic <encoded-value>'
{
  "count": 123,
  "results": [
    {
      "id": "<string>",
      "company": {
        "companyName": "<string>",
        "country": "AF",
        "additionalInfo": {},
        "registrationNumber": "<string>",
        "region": "<string>",
        "type": "<string>",
        "phone": "<string>",
        "website": "<string>",
        "email": "jsmith@example.com",
        "brandNames": [],
        "activityCode": "<string>",
        "tin": "<string>",
        "operatingAddress": "<string>",
        "postalAddress": "<string>",
        "postcode": "<string>",
        "street": "<string>",
        "city": "<string>"
      },
      "meta": {
        "status": "PENDING",
        "approvalStatus": "APPROVED",
        "submissionTime": "2023-11-07T05:31:56Z",
        "soleProprietor": true
      }
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Authorizations

​
Authorization
string
header
required

The request must contain basic auth headers where username is API key and password is API secret.
In order for you to start using our API you will need an API key and API secret.
Both can be retrieved by contacting iDenfy's support or iDenfy's sales team.

Query Parameters

​
created
string<date-time>[]

Multiple values may be separated by commas.

​
page
integer

A page number within the paginated result set.

​
perPage
integer

Number of results to return per page.

​
registrationNumber
string

Response

200 - application/json
​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"