Canada Provincial Search

Request and Response Object Structures.

{
  "entity_name": 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.

{
  "entity_name": "amazon"
}
{
    "success_message": "Record created successfully",
    "data": {
        "id": 141,
        "entity_name": "amazon",
        "address": "canada",
        "created_at": "2023-09-19T11:16:38.588637Z",
        "updated_at": "2023-09-19T11:16:38.588662Z",
        "created_by": "compliancely",
        "search_type": "KYB",
        "status": "Pending"
    },
    "success": true
}
{
    "errors": [
        {
            "entity_name": [
                "This field is required"
            ]
        }
    ],
    "data": {
        "entity_name": "",
        "search_flag": "PROVINCIAL",
        "search_type": "KYB"
    },
    "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."
}
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!