Verify Business ​

Accepts requests for verifying business details. All requests are queued and processed as soon as possible.

Request ​

The following input parameters should be contained in a JSON body object submitted to the endpoint

Request Type : POST ​

Authorization ​

axios.post(API_ENDPOINT, 
  headers: {
    'Ocp-Apim-Subscription-Key': 'd484a1f0d34f4301916d0f2c9e9106a2'
  }
)

axios.post(API_ENDPOINT, 
  headers: {
    'Ocp-Apim-Subscription-Key': 'd484a1f0d34f4301916d0f2c9e9106a2'
  }
)

const res = await axios.post(API_ENDPOINT, { 
  params: { 
    Ocp-Apim-Subscription-Key: 'd484a1f0d34f4301916d0f2c9e9106a2' 
  } 
});

const res = await axios.post(API_ENDPOINT, { 
  params: { 
    Ocp-Apim-Subscription-Key: 'd484a1f0d34f4301916d0f2c9e9106a2' 
  } 
});

Request Values ​

Example Request Body ​

{
  "referenceId": "1d189ba3-8fa6-403f-c0f0-08da9a100324",
  "registrationNumber": "80020001441337",
  "dateOfIncorporation": "2023-12-24T14:15:22Z",
  "businessName": "TEST COMPANY LTD"
}

{
  "referenceId": "1d189ba3-8fa6-403f-c0f0-08da9a100324",
  "registrationNumber": "80020001441337",
  "dateOfIncorporation": "2023-12-24T14:15:22Z",
  "businessName": "TEST COMPANY LTD"
}

Response ​

The verify business endpoint can potentially return successful response or error response

Response Values ​

Example Response Body ​

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "requestUri": "string",
  "status": "Pending"
}

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "requestUri": "string",
  "status": "Pending"
}

Error Response ​

Error Codes ​

When working with our BNV API, you'll encounter errors shown below. Each type of error comes with an appropriate code and suggestion to aid in troubleshooting.

All errors share the same basic response format.code indicating the error code,message providing an overview of the error, description to show more information about the error, suggestion to aid in troubleshooting and type describing the error type