To enable asynchronous call responses (Webhooks), store the token provided in the initial API response.
Fields
Field | Type | Description |
---|---|---|
Token | guid | This is the unique id in our system for your request. |
Success | boolean | Did we successfully process this request? |
ResponseCode | int | See “Response Code Reference” for a description of each code. |
Message | string | A brief description of what happened. |
Processed | datetimeoffset | The current DTO of when we finished processing this request. |
{
"Token": "68F27199-0571-45A2-AEF8-EB4672AA3E81",
"Success": true,
"ResponseCode": 1,
"Message": "Success"
"Processed": "2017-06-12T05:45:24.1996732+00:00"
}
Response Codes
Code(s) | Description |
---|---|
0 | An unknown failure has occurred. |
1 | The transaction was successful, no errors. |
4 | The data provided for the Record was invalid. For example, it could be missing required information such as Phone. |
11, 19 | The CountryCode provided is invalid. |
12 | An invalid Phone number was provided. |
13 | Invalid data was provided. |
16 | The Record does not exist. |
23 | The area code provided is invalid. |