Verify Boiva Pass and Trigger OTP to User's Phone Number

Using the previously created public access token, you can now verify the Boiva Pass by getting an input of Boiva Pass ID from your user and pass it to us.

Step 1 - Validate Boiva Pass ID

curl https://sandbox.boiva.id/v1/verify/pass?pass_id={boiva pass id}
  -H 'Content-Type: application/json' 
  -H 'Authorization: {public_access_token}'
Key ParametersData TypeDescription
AuthorizationString Base64Public Access Token
pass_idStringUser's Boiva pass ID that they receive through the Boiva Mobile Application

The API will trigger an OTP to be send to the phone number that is tied to the User's Boiva Pass ID and will responds with a session_id which will be used for the next API steps along with the duration which shows the expiry time of the session_id.

{
    "Data": {
        "session_id": "YFpIyebZzhi0Hb5M89LpMCjOVKXUTDVmJRsdwjhtu4buiWiRaaleMWbw6qC92VA1tKJkSG80mBCiLU0ur-FvTeq62IxblSs1vuXhl_KtFAu4HDfqQWFZw1nGRBs9aZDYidIh-iEIouwQSl6TE0G0ue_2L9Q6PZCnhS3c9amg5Gx7LA9r2NwaBOguMlMNlPn4_ECARpvAIhlJL5ThDTsmZzqiFBAWxWExDK3IeedTJ4NE2oHpDsUwu2oPPeXqmi0N_7bFufQ-i9kLNZeUg0cm_g_lstAvdHStvCwF5ckj",
        "expired_at": "2022-11-17T14:22:17+07:00"
    }
}
Key ParametersData Type
session_idStringSession identification of that request that should be used for the next step's API
expired_atDateMaximum expiration for session_id with format RFC3339

Verify OTP and Retrieve Validated User's Data

Using the previously created public access token, along with the previously generated session_id, you can now retrieve User's validated data by providing the OTP that is sent to User's phone number to us.

Step 2 - Validate Boiva Pass ID

curl https://sandbox.boiva.id/v1/verify/otp?session_id={session id}&token={token}
  -H 'Content-Type: application/json' 
  -H 'Authorization: {public_access_token}'
AuthorizationStringPublic Access Token
session_idStringSession identification of the request that is generated using the previous API
tokenIntegerOTP token that is sent to user's phone number

The API will responds with User's data along with the validation of each of the data.

{
  "status": 200,
  "message": "OK",
  "data": {
    "pass_id": "2022Brick011-TESS",
    "tier": "Silver User",
    "telcos": {
      "phone_active": true,
      "phone_nik_verification": true
    },
    "identity": {
      "name_verified": 100,
      "ktp_verified": true,
      "birth_date_verified": true,
      "birth_place_verified": 100
    }
  }
}
Key ParametersData TypeDescription
pass_idStringUser's Boiva pass ID that they receive through the Boiva Mobile Application
tierStringUser's tier information in Boiva which is based on the amount of data they validate through Boiva Mobile Application
telcosObjectUser's telcos data and the verification status
phone_activeBooleanUser's phone activeness status that is validated through Telcos
phone_nik_verificationBooleanUser's nik number that is used in card registration status that is validated through Telcos
identityObjectUser's identity data and the verification status
name_verifiedFloatUser's fullname verification status in percentage that is validated through Dukcapil's data

If the
data input is matched, it will return a high percentage, and vice
versa.
ktp_verifiedBooleanUser's ktp number verification status that is validated through Dukcapil's data
birth_date_verifiedBooleanUser's birth date verification status that is validated through Dukcapil's data
birth_place_verifiedFloatUser's fullname verification status in percentage that is validated through Dukcapil's data

If the
data input is matched, it will return a high percentage, and vice
versa.