Retrieving Single eKYC Request

A function to get one of the applying and applied user's data

You can retrieve a single eKYC request using the request id. The method to attach the ID of the request in the URL is as shown on the following.

Request Endpoint: /api/request?id=df0807a9-94d2-4dd1-be73-ba12462d56c Request Type: GET

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.

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

Response status: 200

{
      "requests": 
                  [
                          {
                                "id": "Randomly generated number",
                                "email": "[e-mail]",
                                "phoneNumber": "Valid phone number",
                                "isValidated": true,
                                "isAccepted": true,
                                "idFrontImage": "https://res.cloudinary.com/image/ugidxxnwsbppr3avky7g.jpg",
                                "idBackImage": "https://res.cloudinary.com/image/jfeezjjxpajqmrjuuyti.jpg",
                                "idSideImage": "https://res.cloudinary.com/image/qx0hg3jwxtfzuqiixajn.jpg",
                                "faceImage": "https://res.cloudinary.com/image/wkoqzmjz76gmg5zmfhjo.jpg",
                                "faceMatch": 0.908,
                                "idInformation": {
                                "documentNumber": "Submitted Document Number",
                                "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"
                }
        }
    ]
}

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"
}