Skip to main content

Face Verification

Compare two face images and receive a similarity confidence score. Useful for identity verification flows that match a live selfie against a reference photo.

When to Use​

▾

Use this endpoint when you:

  • Match a selfie against a stored profile picture
  • Verify a user's identity against a previously captured face
  • Detect potential impersonation in onboarding flows

How to Use​

▾
Endpoint
POST/v3/service

Step 1: Register as a Merchant​

▾

Sign up at the RM Merchant Portal.

Step 2: Get the Signature Algorithm​

▾

Follow the Signature Algorithm guide to sign requests.

Step 3: Verify Your Signature​

▾

Confirm signing works using Verify Signature.

Step 4: Send the Request​

▾

POST two Base64-encoded face images to /v3/service with function: "face-compare".

Request Parameters​

▾
serviceSTRINGrequired

Service name. Set to `"ekyc"`.

Example: "ekyc"

versionSTRINGrequired

API version. Currently only `"v1"`.

Example: "v1"

functionSTRINGrequired

Function name. Set to `"face-compare"`.

Example: "face-compare"

requestOBJECTrequired

Comparison payload.

query_image_content_1STRINGrequired

First face image as Base64-encoded string.

Example: "<base64_image>"

query_image_content_2STRINGrequired

Second face image as Base64-encoded string.

Example: "<base64_image>"

Response Parameters​

▾
idSTRING

Internal record ID.

Example: "60f79b737b03abf23ad65206"

actionSTRING

Action required — `NONE_REQUIRED`, `ATTENTION_REQUIRED`, `INCONCLUSIVE`, `RESOLVED`.

Example: "NONE_REQUIRED"

statusSTRING

Verification status — `SUCCESS`, `FACE_ENGINE_CONNECTION_ERROR`, `INCOMPLETE`, `FACE_ENGINE_TIMEOUT`.

Example: "SUCCESS"

isSamePersonBOOLEAN

`true` if both faces likely belong to the same person.

Example: true

similarityINTEGER

Similarity confidence score (0-100).

Example: 99

updatedAtDATETIME

Last update timestamp.

Example: "2021-07-21T15:07:43.266243"

Last updated on by Aiman Danish