Creating an eKYC Request

The next step to create a POST submission request to the Lapis eKYC backend engine

After a successful completion of the document submission and face verification processes, an eKYC request can be generated by providing the system with the user's email address, phone number, and document ID obtained from the responses. It is important to note that both the email and phone number have to be unique, ensuring that no other eKYC request have been initiated using the same or existing phone number or email address. Upon eKYC request submission, the user will receive an OTP number via email. Shortly after, the user will receive an automatically generated phone call, requesting for the last four digits of their submitted document number and the OTP sent to the email address. This verification process ensures the authenticity of the user's identity. Once successfully verified, the user's information will appear on to the Lapis eKYC dashboard, allowing you to track and manage the user's data effectively.

Request Endpoint: /api/kyc-request Request Type: POST

Header:

{
    "Content-Type": "application/json",
    "Accept": "application/json",
    "x-api-key": "Your API key"
}

x-api-key: The API key you obtained upon signing up for the Lapis eKYC dashboard.

Body:

{
    "email":"[email protected]",
    "phoneNumber":"Valid phone number",
    "documentIdentificationId":"Returned response"
}

email: Unique and valid email address of user phoneNumber: Unique and valid phone number of user documentIdentificationId: The ID returned from the previously uploaded document.

Note: Phone number must include country code

Successful Response: Upon successful KYC request, the API response will resemble the following structure:

Response status: 201

{
    "message": "Request submitted"
}

Error Responses:

• If the provided API key is invalid, the following error message will be returned. Please ensure that the API key you provide is correct and valid.

Response status: 401

{
    "error": "invalid api key"
}

• When the provided email or phone number is associated with previously opened request

Response status: 409

{
    "error": "(email, phone) already taken"
}

• If no document verification session is found with the provided ID, the following error message will be returned indicating that no matching session was found for the given ID.

Response status: 400

{
    "error": "There is no document identification data with the provided id!"
}