EKYC APIs

Trusted verification of people and users.

Retrieve current user's verification session

get

This endpoint retrieves the ongoing verification session for the authenticated user. It ensures that users can access their current status in the onboarding process. This information is crucial for users to understand their verification progress and next steps.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/ekyc/me/sessions

HTTPcURLJavaScriptPython

GET /ekyc/me/sessions HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "sessions": {
    "ANY_ADDITIONAL_PROPERTY": {
      "sessionToken": "text",
      "url": "text",
      "id": "text",
      "status": "text",
      "creation_date": "text",
      "modified_date": "text",
      "original_request": {
        "callback": "text",
        "org_id": "text"
      }
    }
  }
}

Initiate a personal verification session

post

This endpoint creates a new eKYC session based on the provided request. It is intended for individual users to securely verify their identity. The session will facilitate trusted verification processes, ensuring user privacy and data protection.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Body

application/json

callbackstringOptional

org_idstringOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

post

/ekyc/me/sessions

HTTPcURLJavaScriptPython

POST /ekyc/me/sessions HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "callback": "text",
  "org_id": "text"
}

{
  "sessionToken": "text",
  "url": "text",
  "id": "text",
  "status": "text",
  "creation_date": "text",
  "modified_date": "text",
  "original_request": {
    "callback": "text",
    "org_id": "text"
  }
}

Retrieve recent verification request for the user

get

This endpoint fetches the most recent verification status for the authenticated user. It ensures that users can easily track their verification progress and status. This information is crucial for maintaining transparency and trust during the onboarding process.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/ekyc/me/sessions/current

HTTPcURLJavaScriptPython

GET /ekyc/me/sessions/current HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "callback": "text",
  "org_id": "text"
}

Retrieve current verification status for the user

get

This endpoint provides the current verification status for the authenticated user. It is intended for personal use, ensuring users can track their onboarding progress. The response will include relevant details about the user's verification state.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/ekyc/me/status

HTTPcURLJavaScriptPython

GET /ekyc/me/status HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "timestamp": "2026-02-13T01:36:06.063Z",
  "total_sessions": 1,
  "verification": {
    "status": "started",
    "reason": "text",
    "timestamp": "2026-02-13T01:36:06.063Z"
  },
  "started": {
    "sessionToken": "text",
    "url": "text",
    "id": "text",
    "status": "text",
    "creation_date": "text",
    "modified_date": "text",
    "original_request": {
      "callback": "text",
      "org_id": "text"
    }
  },
  "rejected": {
    "sessionToken": "text",
    "url": "text",
    "id": "text",
    "status": "text",
    "creation_date": "text",
    "modified_date": "text",
    "original_request": {
      "callback": "text",
      "org_id": "text"
    }
  },
  "success": {
    "sessionToken": "text",
    "url": "text",
    "id": "text",
    "status": "text",
    "creation_date": "text",
    "modified_date": "text",
    "original_request": {
      "callback": "text",
      "org_id": "text"
    }
  },
  "expired": {
    "sessionToken": "text",
    "url": "text",
    "id": "text",
    "status": "text",
    "creation_date": "text",
    "modified_date": "text",
    "original_request": {
      "callback": "text",
      "org_id": "text"
    }
  },
  "submitted": {
    "sessionToken": "text",
    "url": "text",
    "id": "text",
    "status": "text",
    "creation_date": "text",
    "modified_date": "text",
    "original_request": {
      "callback": "text",
      "org_id": "text"
    }
  },
  "created": {
    "sessionToken": "text",
    "url": "text",
    "id": "text",
    "status": "text",
    "creation_date": "text",
    "modified_date": "text",
    "original_request": {
      "callback": "text",
      "org_id": "text"
    }
  }
}