Creating API applications for banks using SMS verification

Parameters

HTTP method

Access rights

URL

Parameters

Note

POST manage_broker_application https://api.admitad.com/website/{w_id}/broker/applications/sync_create/ List of request parameters

Returns the created application, where w_id is the ad space ID.*

  • * Returns the result in the JSON format.

List of request parameters

Name

Description

Type

Requirements

campaign_id *

Program ID to submit applications to

int List of affiliate programs (has_tool=broker_traffic has_sms_verification_for_broker_traffic)
user_notified *

The value “1” indicates that the user has read and agreed with the purpose of data collection, the processing of data, the list of third parties to whom data will be transferred, and the user’s rights under point 2.1 of the Rules for Using the Broker Tool. “0” indicates that the user has not read and has not agreed with the above. If the value is “0,” the user’s form will not be sent through the API.

bool

1 or 0

test_mode

An application will be sent in test mode. In test mode there will be no ‘id’ in the response and ‘responses’ field will be empty.

bool

1 or 0

The other Application parameters

     
  • * Required parameter

Example of use

Example of a request with utility ``curl``:

curl -H 'Authorization: Bearer access_token' -H "accept: application/json" -X POST https://api.admitad.com/website/\{w_id}/broker/applications/sync_create/ -d 'campaign_id=65&first_name=Иван&last_name=Иванов&middle_name=Иванович&mobile_phone=03512345678&work_date=11.11.2016&email=ivanov11123test@gmail.com'

where 65 is the program ID that accepts API applications and requires SMS verification, Ivan Ivanovich Ivanov is an application creator, with the cell phone number: 03512345678, email: ivanov11123test@gmail.com, and 11.11.2016 as the first employment day.

Example of the response from the API server in the JSON format:

{
    "status": "waiting_sms_verification",
    "application_id": 123,
    "server_response":
        {
            "bank": "responded this"
        },
}

Confirming API applications for banks using SMS verification

Parameters

HTTP method

Access rights

URL

Parameters

Note

POST manage_broker_application https://api.admitad.com/website/{w_id}/broker/applications/sync_create/{a_id}/confirm List of request parameters

Returns the created application, where w_id is the ad space identifier.* a_id is the application identifier.*

  • * Returns the result in the JSON format.

List of request parameters

Name

Description

Type

code *

SMS verification code

string
  • * Required parameter

Example of use

Example of a request with utility ``curl``:

curl -H 'Authorization: Bearer access_token' -H "accept: application/json" -X POST https://api.admitad.com/website/\{w_id}/broker/applications/sync_create/\{a_id}/confirm -d 'code=1234'

Example of the response from the API server in the JSON format:

{
    "status": "waiting_sms_verification",
    "application_id": 123,
    "server_response":
        {
            "bank": "responded this"
        },
}