User verification

STAGING_URL: https://switch-api-staging.herokuapp.com
LIVE_URL: https://switchapi.azurewebsites.net

verification update

POST https://switch-api-staging.herokuapp.com/user/verification/update

This endpoint allows you to update user verification information.

Headers

Name	Type	Description
auth_token	string	the format for auth_token is Bearer token_string

Request Body

Name	Type	Description
next_of_kin_email_address	string	Next of Kin's email address
next_of_kin_phone_number	string	Next of Kin's Phone number
next_of_kin_relationship	string	user's relationship with next of kin
next_of_kin_name	string	Name of Next of Kin
nearest_landmark	string	Nearest Landmark to user's address
nigerian_contact_name	string	Name of Nigerian contact. Required if diaspora user.
nigerian_contact_phone	string	Phone number of Nigerian contact. Required if diaspora user.
nigerian_contact_address	string	Address of Nigerian contact. Required if diaspora user
nigerian_contact_relationship	string	Relationship between user and Nigerian contact. Required if diaspora user
address	string	user's address
state	string	user's state of residence
city	string	user's city of residence
zipcode	string	user's zipcode
bvn	string	User's bvn. Optional for diaspora users
photo_id_number	string	number of photo id
photo_id_expiry	string	expiry date of photo id
photo_id_issuer	string	photo id issuer (valid values: drivers_license, voters_card, international_passport and national_id_card)
photo_id_url	string	url of the image containing user photo it
signature_url	string	url of the image containing user signature
image_selfie_url	string	url of image selfie

200 Cake successfully retrieved.

{
    "message": "verification information updated successfully"
}

400

{
    "message": "Error occurred verifying BVN",
    "errors": {
        "bvn": "BVN is invalid, please confirm your bvn and try again"
    }
}

Request verification

POST https://switch-api-staging.herokuapp.com/user/verification/process

This endpoint makes a request for verification

Headers

Name	Type	Description
auth_token	string	The format for auth_token is Bearer token_string

200

{
    "message": "verification request sent successfully"
}

Get Verification Progress

GET https://switch-api-staging.herokuapp.com/user/verification/progress

This endpoint retrieves user verification progress

Headers

Name	Type	Description
auth_token	string	The format for auth_token is Bearer token_string

200

{  
   "message": "Verification progress retrieved successfully",
   "data": {  
      "current": 20,
      "fields": {  
         "bvn": null,
         "full_address": null,
         "photo_id_url": null,
         "signature_url": null,
         "image_selfie_url": "image_selfie_url_IMG_2026.jpg"
      }
   }
}