Request and Response Object Structures.

{
    "name": string,
    "business_number": string,
    "request_date": 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
        }
    ]
}

Business Name:

This is a supplier's legal, operating, or trading name, displayed on an invoice or posted on a sign at the place of business.

If you do not get any results using the name displayed, contact the business owner to find out the exact name they gave to the Canada Revenue Agency.

GST/HST Number:

Enter only the first nine digits of the GST/HST account number. Do not include letters.

A supplier must include the GST/HST account number on receipts, invoices, contracts, or other business papers it gives out when it supplies taxable goods or services of $30 or more.

Transaction Date: The transaction date is the date on the receipt, invoice, contract or other business paper.

Sample Requests and Responses.

{
    "name": "Royal Bank Of Canada",
    "business_number": "119126357",
    "request_date": "2023-08-19"
}

{
    "results": [
        {
            "id": 126,
            "entity_name": "Royal Bank Of Canada",
            "address": "canada",
            "created_at": "2023-09-19T11:00:56.921274Z",
            "updated_at": "2023-09-19T11:00:56.921288Z",
            "created_by": "compliancely",
            "search_type": "KYB",
            "status": "Pending",
            "raw_data": [],
            "message": "Record created successfully"
        }
    ]
}

{
    "business_number": [
        "Business Number field is required"
    ],
    "status": 0
}

{
    "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."
}

200

403Forbidden can be one from the list