Skip to content

Cloud API

To simplify and accelerate the evaluation process, ID R&D provides access to the server side component of the IDLive® eKYC Toolkit via a Cloud API. This allows for testing the core functionality without deploying the full IDLive® eKYC Toolkit locally.

Access Credentials

A unique API key is provided for evaluation access and must be included in every request to the Cloud API.

The Cloud API URL, API key, and expiration date can be found in the customer portal at:
https://dev.idrnd.net/products/EKYC/cloud

If you do not have access to this page, please contact us to request access.

Important Notes

  • The Cloud API is provided for evaluation purposes only.
  • It must not be used in production environments or for load testing.
  • The API key is limited to 100 requests per day.

Available Endpoint

Currently, the Cloud API provides access to a single main HTTP method: POST /check

This endpoint enables evaluation of the key eKYC verification steps, including face check, document check, and face-to-document matching. The API Usage Guide section provides a detailed overview of this method's parameters.

Example Request

curl -X 'POST' \
  'https://ekyc-rest-api.idrnd.net/check' \
  -H 'x-api-key: <API-KEY>' \
  -H 'accept: application/json' \
  -H 'Content-Type: multipart/form-data' \
  -F 'checkModel={"operations":["FACE_CHECK","DOC_CHECK","FACE_MATCH_VALIDATION"]};type=application/json' \
  -F 'face=@/path/to/face-encrypted-data' \
  -F 'doc=@/path/to/doc-encrypted-data'

import requests, json

headers = {
    "x-api-key": "<API-KEY>",
    "accept": "application/json"
}

check_model = {
    "operations": ["FACE_CHECK", "DOC_CHECK", "FACE_MATCH_VALIDATION"]
}

with open("/path/to/face-encrypted-data", "rb") as face_file, \
     open("/path/to/doc-encrypted-data", "rb") as doc_file:

    files = {
        "checkModel": ("checkModel", json.dumps(check_model), "application/json"),
        "face": face_file,
        "doc": doc_file
    }

    response = requests.post(
        "https://ekyc-rest-api.idrnd.net/check",
        headers=headers,
        files=files
    )

print(response.status_code)
print(response.json())

Replace <API-KEY> with the actual key found in the customer portal.