Create a Candidate via Form

This creates new candidate via form

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

Headers

NameTypeDescription

token*

String

API secret token

Request Body

NameTypeDescription

firstName*

String

first name of candidate

middleName

String

middle name of candidate

lastName*

String

last name of candidate

mobile*

String

mobile of candidate

dateOfBirth

String

date of birth of candidate

email

String

email of candidate

image*

String

candidate image URL

{
    "firstName": "John",
    "middleName": "Michael",
    "lastName": "Doe",
    "mobile": "08036xxxxxx",
    "dateOfBirth": "2000-01-01",
    "email": "testemail@gmail.com",
    "image": "https://cdn.youverify.co/1655466566309-lLSfNTlhElMTtbXW-QE-q.jpg"
}
HTTP/1.1 201 CREATED
{
            "success": true,
            "statusCode": 201,
            "message": "Candidate created successfully!",
            "data": {
                "firstName": "John",
                "middleName": "Michael",
                "lastName": "Doe",
                "dateOfBirth": "2000-01-01",
                "photo": null,
                "email": "testemail@gmail.com",
                "mobile": "08036xxxxxx",
                "idNumber": null,
                "type": "form",
                "medium": "form",
                "businessId": "615c2deb203b96532838418b",
                "createdAt": "2021-11-12T11:44:29.335Z",
                "lastModifiedAt": "2021-11-12T11:44:29.335Z",
                "_createdAt": "2021-11-12T12:44:2929+01:00",
                "_lastModifiedAt": "2021-11-12T12:44:2929+01:00",
                "id": "618e539d540fb2e1d076427a"
            },
            "links": []
        }

Last updated