API Integration Documentation
The NumCheck API allows you to make requests to our servers to initialize various methods, such as requesting an authorization call. Any registered NumCheck client can use our API.
Definitions
-
Service - is required to use our API. A Service is created manually in the Dashboard under “My Services”. Each Service lets you view detailed authorization statistics and configure fine-grained API settings. Every Service has a unique identifier (Service ID) and a randomly generated secret key.
-
Authorization - we refer to as "authorization" all calls initiated to your clients using the init-call API method.
-
Secret Key - a special, unique, randomly generated 32-character string that grants access to our API. If your secret key is compromised, you can generate a new one at any time in your Personal Account service settings.
What Is Required to Work with the API?
-
To use the API, you need to register and log in to your Personal Account. Then navigate to the "My Services" tab to create a new service or manage an existing one.
-
To use the API you will need the "Secret Key" of your Service and the init-call method.
-
That's all you need to get started.
init-call Method
This method sends a request to call the specified user phone number for further authorization in the client's system. The user will receive a call, and the client will receive the call data.
Method Parameters
| Parameter | Value | Description |
|---|---|---|
| X-AUTH-Token header |
string 32 characters required |
Secret Key of your Service |
| phone GET parameter |
number required |
The user’s phone number to which the authorization call will be made |
| description GET parameter |
string up to 64 characters optional |
User information. You can pass information about your user, such as a label, nickname, email address, etc. |
Request Example
$client_phone = 79991234567;
$request_description = 'some nickname';
-X "POST" \
-H "X-AUTH-Token: $secret_key"
Method Response Parameters
| Parameter | Description |
|---|---|
| callId | Unique ID in the NumCheck system, which allows you to check the call status using the get-call-info |
| callerId | The phone number from which our system made the call |
| code | The code consisting of the last 4 digits of the calling number from which our system made the call |
| statusCode | HTTP response code |
| errorCode | Error code |
| message | Error message |
| success | Request execution status |
Response Example
"callId": 33168,
"callerId": 37166004953,
"code": 4953,
"statusCode": 200,
"errorCode": 0,
"message": null,
"success": true
}
get-call-info Method
This method retrieves information about a completed call.
Method Parameters
| Parameter | Value | Description |
|---|---|---|
| X-AUTH-Token header |
string 32 characters required |
Secret Key of your Service |
| callId GET parameter |
number required |
The NumCheck system ID, returned earlier in the response to the init-call |
Request Example
$call_id = 1080;
-X "POST" \
-H "X-AUTH-Token: $secret_key"
Method Response Parameters
| Parameter | Description |
|---|---|
| callId | Unique ID in the NumCheck system |
| callerId | The phone number from which our system made the call |
| code | The code consisting of the last 4 digits of the calling number from which our system made the call |
| status | Call status 0 - call in progress 1 - call completed successfully -1 - call was not answered |
| statusCode | HTTP response code |
| errorCode | Error code |
| message | Error message |
| success | Request execution status |
Response Example
"callId": 33168,
"callerId": 37166004953,
"code": 4953,
"status": 1,
"statusCode": 200,
"errorCode": 0,
"message": null,
"success": true
}