Skip to main content
GET
/
kyb
/
forms
/
{id}
Retrieve KYB form info
curl --request GET \
  --url https://api.example.com/kyb/forms/{id}/ \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "company": {
    "companyName": "<string>",
    "country": "AF",
    "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>",
    "additionalInfo": {}
  },
  "meta": {
    "status": "PENDING",
    "approvalStatus": "APPROVED",
    "submissionTime": "2023-11-07T05:31:56Z",
    "soleProprietor": true
  },
  "documents": [
    {
      "id": "<string>",
      "type": "INCORPORATION_CERT",
      "file": "<string>",
      "filename": "<string>"
    }
  ],
  "beneficiaries": [
    {
      "id": "<string>",
      "info": {
        "infoType": "INDIVIDUAL",
        "name": "<string>",
        "surname": "<string>",
        "email": "jsmith@example.com",
        "phone": "<string>",
        "dateOfBirth": "2023-12-25",
        "country": "AF",
        "nationality": "AF",
        "documentNumber": "<string>",
        "personalNumber": "<string>",
        "citizenship": "AF",
        "countryOfBirth": "AF",
        "residentialAddress": "<string>",
        "countryOfResidence": "AF",
        "postcode": "<string>",
        "address": "<string>",
        "street": "<string>",
        "city": "<string>",
        "tin": "<string>",
        "taxResidence": "AF",
        "selfDeclaredPep": true,
        "additionalInfo": {}
      },
      "parent": "<string>",
      "beneficiaryType": "CEO",
      "beneficiaryTypes": [
        "CEO"
      ],
      "positions": [],
      "formFiller": true,
      "ownershipPercentage": 50
    }
  ],
  "clientSystem": {
    "ipAddress": "<string>",
    "timeZone": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Authentication for actions with all operations associated with KYB form.
Token obtained from KYB form token generation endpoint as tokenString value.

Path Parameters

id
string
required

A unique value identifying this company.

Response

200 - application/json
id
string
required
company
object
required
meta
object
required
documents
object[]
beneficiaries
object[]
clientSystem
object