API Reference
API ReferenceChangelogFAQDashboard

Auto KYB API examples

Use the Create applicant method to send the Auto KYB verification (Automated corporate registry check and Corporate AML check) API requests.

Depending on the verification sources used within Auto KYB, and in some cases, depending on the country, you have to send different companyInfo objects in your API calls.

Request example

The full Auto KYB request looks as follows: 

curl -X POST \
  'https://api.sumsub.com/resources/applicants?levelName=kyb-level' \
  -H 'Content-Type: application/json' \
  -d '{
         "externalUserId": "someClientUserIdCompany",
         "fixedInfo": {
            "companyInfo": {
                "companyName": "Some Company",
                "registrationNumber": "12345678",
                "country": "GBR"
            }
        },
        "type": "company"
      }'

Local & Regional

Here is an API example for retrieving company information when using the Local & Regional pack of data sources:

{
  "companyName": "Some Company",
  "registrationNumber": "12345678",
  "country": "GBR"
}

Advanced

Find the Advanced coverage API calls below. Some countries have exceptional examples, so their API calls are presented separately for each case.

📘

Note

  • The registrationNumber field in the API call for Canada is an incorporation number consisting of 7 digits without letter prefixes (e.g., ON, BC, A).
  • The registrationNumber field in the API call for the USA is a file number (also known as a corporate or business identification number), typically assigned to a business entity upon registration with the state.
  • The registrationLocation field in the API call for Germany represents the Registration Authority Location.

General

{
  "companyName": "Sum and Substance ltd",
  "registrationNumber": "12345678",
  "country": "GBR"
}

USA

{
      "companyName": "GITLAB INC.",
      "registrationNumber": "12345678",
      "country": "USA",
      "address": {
        "state": "DE",
        "country": "USA"
      }
  }

Canada

{
      "companyName": "BROOKFIELDTS GP INC.",
      "registrationNumber": "1234567",
      "country": "CAN",
      "address": {
        "state": "ON",
        "country": "CAN"
      }
  }

Germany

{
  "companyName": "Sumsub GmbH",
  "registrationNumber": "HRB123456B",
  "country": "DEU"
  "registrationLocation": "Amtsgericht Berlin"
}

Global

This is an API call fragment used for performing Auto KYB verification via Global verification sources: 

{
  "companyName": "Some Company",
  "registrationNumber": "HRB123456B",
  "country": "DEU"
}