KYB

Through our KYB API, clients can perform in-depth checks on businesses by providing one of company name or registration number. By leveraging trusted third party data sources, clients can have access to their PDF report.

Creating a KYB verification and accessing PDF report involves three key steps:

• Search for and select the company you want to perform the check on.
• Use the company_code field in your request to pass the id from the previous response payload."
• Download PDF report

POST Search for a company

---

API

Description: Search for a company based on company name or registration number

Endpoint: POST /api/v4/kyb_verifications/companies

Properties:

Property	Sub-property	Required	Type	Notes
kyb_search_company		yes	object
	reference	yes	string
	country_code	yes	string	ISO 3166-1 alpha-3 code
	company_identifier	yes	string	company name or registration number

Sample Response:

{
    "companies": [
        {
            "id": "NZ|OTQyOTAzNjkxNzIxMQ",
            "companyName": "KIWIBANK LIMITED",
            "companyNumber": "9429036917211",
            "status": "Registered",
            "type": "NZ Limited Company",
            "startDate": "2001-05-03",
            "aliases": [
                "No trading name"
            ]
        },
        {
            "id": "NZ|OTQyOTA0MDQwMjU0Mw",
            "companyName": "AIR NEW ZEALAND LIMITED",
            "companyNumber": "9429040402543",
            "status": "Registered",
            "type": "NZ Limited Company",
            "startDate": "1940-04-25",
            "aliases": [
                "Air New Zealand Limited"
            ]
        }
    ]
}

POST Create a KYB verification

API

Description: Create a KYB verification in order to access their PDF report

Endpoint: POST /api/v4/kyb_verifications

Properties:

Property	Sub-property	Required	Type	Notes
kyb_verification		yes	object
	reference	yes	string
	country_code	yes	string	ISO 3166-1 alpha-3 code
	company_identifier	yes	string	company name or registration number
	company_code	yes	string	this is the id field from the previous call, for example: NZOTQyOTA0MDQwMjU0Mw

Sample Response:

{
  "id": 28,
  "created_at": "2024-10-11T17:39:06.959+13:00",
  "reference": "TEST-123",
  "country_code": "NZL",
  "company_identifier": "Kiwi Bank"
}

GET Download KYB Verification report

API

Description: Download PDF Report of KYB verification and archive from our server

Endpoint: GET /api/v4/pdf/kyb_verifications/:id

Examples

Search company

const http = require('axios')

http.post('https://integration.aplyid.com/api/v4/kyb_verifications/companies', {
  "kyb_search_company": {
      "reference": "TEST-123",
      "country_code": "NZL",
      "company_identifier": "Kiwi"
  }
}, {
  headers: {
    'Aply-API-Key': 'YOUR_API_KEY',
    'Aply-Date': 'YOUR_DATE',
    'Aply-Signature': 'YOUR_GENERATED_SIGNATURE'
  }
}).then(response => {
  // Do some stuff
}).catch(error => {
  console.log(error.response.data.message)
})

Create KYB

const http = require('axios')

http.post('https://integration.aplyid.com/api/v4/kyb_verifications', {
  "kyb_verification": {
      "reference": "TEST-123",
      "country_code": "NZL",
      "company_identifier": "Kiwi Bank",
      "company_code": "NZ|OTQyOTAzNjkxNzIxMQ"
  }
}, {
  headers: {
    'Aply-API-Key': 'YOUR_API_KEY',
    'Aply-Date': 'YOUR_DATE',
    'Aply-Signature': 'YOUR_GENERATED_SIGNATURE'
  }
}).then(response => {
  // Do some stuff
}).catch(error => {
  console.log(error.response.data.message)
})

Error Codes

401 Unauthorized

{
  "error_code": "AUTH_FAILED",
  "message": "Bad credentials"
}

403 Forbidden

{
  "error_code" : "FORBIDDEN",
  "message" : "You're not authorized to access this resource"
}

422 Unprocessable Entity

// For validation failures
{
  "error_code" : "NOT_CREATED",
  "message" : "Country code can't be blank"
}