Feel free to reach techsupport@surepass.io for any technical support or guidance.
Authorization
header as Bearer TOKEN
.https://sandbox.surepass.io
https://kyc-api.surepass.io
Header | Required | Description |
---|---|---|
Authorization | Yes | Bearer token authentication using JWT format |
Content-Type | Yes | Must be set to application/json |
Parameter | Type | Required | Description |
---|---|---|---|
id_number | String | Yes | The GST number to be verified |
business_name | String | Yes | The business name associated with the GST number |
{
"id_number": "807189821",
"business_name": "the mule"
}
Parameter | Type | Description |
---|---|---|
data | Object | Contains the verification result details |
data.client_id | String | Unique identifier for the verification request |
data.id_number | String | The GST number that was verified |
data.business_name | String | The business name that was provided for verification |
data.is_registered | Boolean | Indicates whether the GST number is registered (true) or not (false) |
status_code | Integer | HTTP status code of the response |
success | Boolean | Indicates if the API call was successful |
message | String | Human-readable description of the result |
message_code | String | Machine-readable code representing the result |
{
"data": {
"client_id": "canada_gst_verification_IgfMgMEviIuhYhazmnhV",
"id_number": "807189832",
"business_name": "the mule",
"is_registered": true
},
"status_code": 200,
"success": true,
"message": "Success",
"message_code": "success"
}
{
"data": null,
"status_code": 400,
"success": false,
"message": "Invalid GST number format",
"message_code": "invalid_input"
}
curl --location --request POST 'https://kyc-api.surepass.app/api/v1/canada/gst-verification' \
--header 'Content-Type: application/json' \
--data-raw '{
"id_number": "807189821",
"business_name": "the mule"
}'
{
"data": {
"client_id": "canada_gst_verification_IgfMgMEviIuhYhazmnhV",
"id_number": "807189832",
"business_name": "the mule",
"is_registered": true
},
"status_code": 200,
"success": true,
"message": "Success",
"message_code": "success"
}