API Reference

The API usage and endpoint documentation

Creating an eKYC Request

The Lapis eKYC API is accessed through the HTTP protocol by making a request to the API endpoint. The HTTP protocol request is as follows:

https://kyc-be.rubilink.app

Uploading The Document

To ensure a seamless eKYC verification process, it is crucial to successfully upload the user's document. This step is vital as it allows for accurate face verification and ultimately facilitates the creation of a eKYC request. Each uploaded document is assigned a unique ID, which serves as a mandatory link between the face verification and the corresponding document in the eKYC request. To ensure successful document upload and verification, please ensure that the document image URL points to a downloadable image file or provide a valid base64 image of the document in either PNG or JPEG format. Following upload, the document undergoes a thorough validation process to ensure its authenticity. If the document is found to be invalid, an appropriate error message will be returned. Conversely, if the document is deemed valid, it will be securely stored in our database. Additionally, we extract relevant information from the document and provide it, along with its unique ID, to facilitate the completion of the eKYC verification process.

When it comes to uploading images, the Rubi Labs developer team gives developers or users the flexibility of two options. First, you can simply provide us with the image URL, ensuring that it directs to the correct and exact location of the image file. Alternatively, you can choose to upload the image as a base64 string, but please make certain that it is in either PNG or JPEG format.It's important to note that while combining base64 and URL options in a single request is possible, please remember that each side of the document can only have one type of image.Incase of base64 images, please be mindful of the total size. The combined size of all images should not exceed 30MB. This way, we ensure that our system handles your request smoothly and efficiently.

Request Endpoint: /api/document-authentication Request Type: POST

Header:

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

x-api-key: This will be the API key obtained upon signing up for the Lapis eKYC webpage.

Body: (When opting to upload images using a URL)

{
    "frontImage":"https://example.com/idFrontImage.jpg",
    "backImage":"https://example.com/idBackImage.jpg",
    "sideImage":"https://example.com/idSideImage.jpg"
}

Body: (When opting to upload images using a base64)

{
    "frontImage_base64":"/9j/4AAQSkZJRgABAQAASABIAAD/4QBMRXhpZgAATU0AKgAAAAgAAgESAAMAAAABAAYA................",
    "backImage_base64":"/9j/xvbhxchvbhbvcxvc/4QBMRXhpZgAATU0AKgAAAAgAAgESAAMAAAABAAYAAIdpAAQA................",
    "sideImage_base64":"/9j/4AAQSkZJRgABAQAASABIAAD/zxcdbshshdhsbhfdbhfdbvhfdhvfdgyufgdygygygy................"
}

Body: (When opting to upload images using both base64 and URL. Please keep in mind that you have the flexibility to use any combination of image upload methods. However, it's important to note that you can only use one image type for each side of the document. This means that you won't be able to mix different image types on the same side.)

{
    "frontImage":"https://example.com/idFrontImage.jpg",
    "backImage_base64":"/9j/xvbhxchvbhbvcxvc/4QBMRXhpZgAATU0AKgAAAAgAAgESAAMAAAABAAYAAIdpAAQA................",
    "sideImage_base64":"/9j/4AAQSkZJRgABAQAASABIAAD/zxcdbshshdhsbhfdbhfdbvhfdhvfdgyufgdygygygy................"
}

frontImage/ frontImage_base64: Front side image URL of the document. backImage/ backImage_base64: Back side image URL of the document. sideImage/ sideImage_base64: Side image url of the document (To check thickness).

Successful Response: Upon successful document verification, the API response will resemble the following structure:

Response status: 201

{
    "documentIdentificationId": "64d3a6f3-6f71-4e15-a6ee-08b95b8f724e",
    "result": {
        "documentNumber": "30213450820",
        "firstName": "firstName",
        "middleName": "middleName",
        "lastName": "lastName",
        "fullName": "FIRST MIDDLE LAST",
        "age": 25,
        "dob": "2000/02/15",
        "dob_day": 15,
        "dob_month": 2,
        "dob_year": 2000,
        "expiry": "2025/03/15",
        "expiry_day": 15,
        "expiry_month": 3,
        "expiry_year": 2025,
        "daysToExpiry": 264,
        "issued": "2021/07/07",
        "issued_day": 7,
        "issued_month": 7,
        "issued_year": 2021,
        "daysFromIssue": 719,
        "address1": "260-1262, Akamatsucho",
        "documentType": "D",
        "documentSide": "FRONT",
        "issueAuthority": "東京都",
        "issuerOrg_full": "Japan",
        "issuerOrg_iso2": "JP",
        "issuerOrg_iso3": "JPN",
        "nationality_full": "Japan",
        "nationality_iso2": "JP",
        "nationality_iso3": "JPN",
        "internalId": "674"
    }
}

documentIdentificationId: Please retain the unique document ID as it will be required for both face verification and the KYC request process. This ID serves as a crucial identifier to link these steps accurately.