Verify One Time Password (OTP)

API URL

URL used to send HTTP requests:

https://portal.bulkgate.com/api/1.0/otp/verify

POST /api/1.0/otp/verify HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache

Parameters table

PARAMETER NAMEVALUEMANDATORYDEFAULT VALUE
application_idApplication IDYes-
application_tokenApplication tokenYes-
idId received by sending one time passwordYes-
codeCode to be verifiedYesstring

Example of full request

POST /api/1.0/otp/verify HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache

{
    "application_id": "APPLICATION_ID",
    "application_token": "APPLICATION_TOKEN",
    "id": "otp-id",
    "code": "0000"
}

Response to this command may be:

In case of success:

{
    "data": {
        "id": "opt-id",
        "verified": true
    }
}

In case of invalid code:

{
    "data": {
        "id": "opt-id",
        "verified": false
    }
}

In case of error:

{
    "type": "unknown_identity",
    "code": 400,
    "error": "Unknown identity",
    "detail": null
}

{
    "type": "invalid_input_parameters",
    "code": 400,
    "error": "Invalid input parameters",
    "detail": null
}
← PreviousNext →