1. Home
  2. Docs
  3. Authentification
  4. OTP User Authentication (One time Password)
  5. Generate Challenge

Generate Challenge

To generate Challenge you will use:

  • Bizao-URI: /challenge/v1/challenges
  • Bizao-Host: api.bizao.com

Your query will contain the Headers below:

HeaderDescription/Content
Content-Typeapplication/json
AuthorizationYOUR_ACCESS_TOKEN

The body of your query will contain the parameters below into a “challenge” object (JSON):

ParameterUsageDescription
methodMandatoryAlways: OTP-SMS-AUTH
countryMandatoryCountry code: see our topic “Specific API-Challenge parameter value by authorized country”.
serviceMandatoryAlways: BIZAO
partnerIdMandatoryAlways: PDKSUB
inputsMandatoryJSON array of {key1: value1, key2: value2} entries contain all the necessary inputs to perform the challenge:
  • MSISDN of the end-user, used to build the Bizao-token
  • confirmationCode, the OTP received by the end-user (empty at this stage)
  • message, the message that will be sent to the end-user with the confirmationCode.Authorized wording:French: “Pour confirmer votre achat XXXXX merci d’entrer le code suivant : %OTP%”English: “Please confirm your purchase XXXXX using this code: %OTP%”%OTP% is mandatory 160 characters maximum

  • otpLength, always with 4 as value
  • senderName, friendly name displayed on end-user device (11 characters maximum)

A sample request :

curl -i -X POST \
https://api.bizao.com/challenge/v1/challenges/ \
-H 'authorization: Bearer YOUR_ACCESS_TOKEN' \
-H 'cache-control: no-cache' \
-H 'content-type: application/json' \
-d '
{
"challenge": {
    "method": "OTP-SMS-AUTH",
    "country": "CIV",
    "service": "BIZAO",
    "partnerId": "PDKSUB",
    "inputs": [{
        "type": "MSISDN",
        "value": "+22500000000"
        }, {
        "type": "confirmationCode",
        "value": ""
        }, {
        "type": "message",
        "value": "Please confirm your purchase using this code: %OTP%"
        }, {
        "type": "otpLength",
        "value": "4"
        }, {
        "type": "senderName",
        "value": "yourName"
        }]
    }
}'

Success challenge query response (header)

HTTP/1.1 201 CreatedLocation:
http://[HOST]/challenge/v1/challenges/{challengeId}
  • Sample:
    location →/challenge/v1/challenges/5c1ba20a7970d1f9f2508c93
Was this article helpful to you? Yes 1 No 1

How can we help?