Create candidate

This endpoint creates a new candidate for the verification

POST

{{baseurl}}//v1/candidates
Field
Type
Description

token

String

Secret API token

Parameter

Field
Type
Description

first_name

String

first name of candidate

middle_name optional

String

middle name of candidate

last_name

String

last name of candidate

mobile

String

mobile of candidate

dob optional

String

date of birth of candidate

email optional

String

email of candidate

country optional

String

candidate country

Default value: Nigeria

{
    "first_name": "John",
    "last_name": "Doe",
    "gender": "male",
    "email": "john.doe@gmail.com",
    "dob": "1995-09-09",
    "mobile": "08000000000",
    "country": "Nigeria"
}
HTTP/1.1 201 CREATED
{
       "message": "Successful",
       "data": {
           "id": "4b69172e-7b48-4aa5-b2a2-306bd8b6f647",
           "reference_id": "4b69172e-7b48-4aa5-b2a2-306bd8b6f647",
           "name": "John Michael Doe",
           "first_name": "John",
           "middle_name": "Michael",
           "last_name": "Doe",
           "gender": null,
           "dob": null,
           "mobile": "08000000000",
           "email": "john,doe@gmail.com",
           "country": "Nigeria",
           "has_live_photo": false,
           "live_photo_path": null,
           "id_numbers": [],
           "created_at": "2022-01-31T13:48:34.759Z"
       },
       "status_code": 201
   }

Last updated