Create a candidate via Identity

This creates a candidate via identity

POST {{baseurl}}/v2/api/addresses/candidates/identity

Headers

Name	Type	Description
token*	String	API secret token

Request Body

Name	Type	Description
type*	String	type of ID. One of bvn, nin, ndl
idNumber*	String	ID base on the provided type
subjectConsent*	Boolean	Candidate consent. Must be true

Sample Request

{
    "type": "bvn",
    "idNumber": "00000000000",
    "subjectConsent": true
}

Success Response

HTTP/1.1 201 CREATED
{
        "success": true,
        "statusCode": 201,
        "message": "Candidate created successfully!",
        "data": {
            "firstName": "Peter",
            "middleName": "Phillip",
            "lastName": "Uche",
            "dateOfBirth": "1950-02-04",
            "photo": "data:image/jpg;base64,/9j/4AAQSkZJRgABAgAAAQAB"
            "email": null,
            "mobile": "08000000000",
            "idNumber": "00000000000",
            "type": "bvn",
            "medium": "identity",
            "createdAt": "2021-11-05T07:56:48.953Z",
            "lastModifiedAt": "2021-11-05T07:56:48.953Z",
            "_createdAt": "2021-11-05T08:56:4848+01:00",
            "_lastModifiedAt": "2021-11-05T08:56:4848+01:00",
            "id": "6184e3c081ee238921cb9e86"
        },
        "links": []
    }