post https://app1.compliancely.com/api/v1/kyb/canada/business/
- RID is the unique record id.
- ID is the unique entity/submission id.
- Status can be ('Pending', 'Ready To Pick', 'Processing', 'Completed', 'Error').
- Status is the current state of an entity.
Request and Response Object Structures.
{
"name": string,
"business_number": string
}
{
"results": [
{
"id": integer,
"entity_name": string,
"address": string,
"created_at": string,
"updated_at": string,
"created_by": string,
"search_type": string,
"status": string,
"raw_data": [],
"message": string
}
]
}
Sample Requests and Responses.
{
"name": "Microsoft",
"business_number": ""
}
{
"results": [
{
"id": 276,
"entity_name": "Microsoft",
"address": "canada",
"created_at": "2022-09-07T15:26:24.077037Z",
"updated_at": "2022-09-07T15:26:24.077056Z",
"created_by": "compliancely",
"search_type": "KYB",
"status": "Pending",
"raw_data": [],
"message": "Record created successfully"
}
]
}
{
"errors": [
{
"code": "name",
"message": "Either Business Name or Charity Business Number field is required"
},
{
"business_number": "name",
"message": "Either Business Name or Charity Business Number field is required"
}
],
"data": {
"name": "",
"business_number": "",
"search_flag": "BUSINESS"
},
"success": false
}
{
"detail": "Authentication credentials were not provided."
}
{
"status": 0,
"custom_credit_message": [
"Credit limit reached! For assistance, please contact the support"
]
}
{
"detail": "Invalid token."
}
{
"detail": "Invalid token header. No credentials provided."
}