Asynchronous Callback

post https://api.verified.africa/sfx-verify/v3/id-service/

Body Params

searchParameter

string

Defaults to 22222222223

The BVN will be passed into this field

transactionReference

string

Defaults to To be generated by the customer

This is a field that uniquely identifies your transaction. We generate this field if you leave it empty; however, we encourage you to generate it for proper reconciliation

verificationType

string

Defaults to BVN-FULL-DETAILS

This field is used to identify the service being called. Ensure to use the value provided exactly as provided

callbackUrl

string

Defaults to https://webhook.site/7518d538-18ad-4eeb-b944-e168c54d020f

The callback url is inputted here

callbackEmail

string

Defaults to somto@yopmail.com

The callback email is inputted here

Headers

userid

string

This is your user id retrieved from the portal. Check the getting started article to understand how to retrieve your userid

apiKey

string

This is your api key retrieved from the portal. Check the getting started article to understand how to retrieve your apiKey

Responses

Language


xxxxxxxxxx
13
1
curl --request POST \
2
     --url https://api.verified.africa/sfx-verify/v3/id-service/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "searchParameter": "22222222223",
8
  "transactionReference": "To be generated by the customer",
9
  "verificationType": "BVN-FULL-DETAILS",
10
  "callbackUrl": "https://webhook.site/7518d538-18ad-4eeb-b944-e168c54d020f",
11
  "callbackEmail": "somto@yopmail.com"
12
}
13
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400