EKYC Admin APIs

Trusted verification of people and users.

Admin list of user sessions

get

Retrieves a list of user sessions for administrative oversight. This endpoint allows administrators to manage and monitor user activity effectively. The results can be paginated using the 'limit' and 'start' parameters to facilitate efficient data handling.

💻 Service Credentials is required to access this service.

🔒 Permission: ekyc.session.list is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Query parameters

limitinteger · int32OptionalDefault: 1024

startinteger · int32OptionalDefault: 0

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/ekyc/admin

HTTPcURLJavaScriptPython

GET /ekyc/admin 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"
        }
      }
    }
  }
]

Retrieve a specific user's session details

get

This endpoint allows administrators to retrieve the session details of a specific user identified by their user ID. It is intended for use in managing user sessions and ensuring proper onboarding flow and state management. This operation is crucial for maintaining oversight and control over user interactions within the EKYC system.

💻 Service Credentials is required to access this service.

🔒 Permission: ekyc.session.get is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

userIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/ekyc/admin/{userId}/sessions

HTTPcURLJavaScriptPython

GET /ekyc/admin/{userId}/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"
      }
    }
  }
}

Create a session for user verification

post

Initiates a verification session for a specific user identified by userId. This operation is intended for admin use, allowing trusted verification processes to be managed effectively. Ensure that the provided session request adheres to the required structure for successful session creation.

💻 Service Credentials is required to access this service.

🔒 Permission: ekyc.session.create is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

userIdstringRequired

Body

application/json

callbackstringOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

post

/ekyc/admin/{userId}/sessions

HTTPcURLJavaScriptPython

POST /ekyc/admin/{userId}/sessions HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "callback": "text"
}

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

Retrieve the session status of a specific user

get

This endpoint allows administrators to access the session status of a specified user. It provides insights into the user's current onboarding state and session details. This information is crucial for managing user verification processes effectively.

💻 Service Credentials is required to access this service.

🔒 Permission: ekyc.session.get is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

userIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/ekyc/admin/{userId}/status

HTTPcURLJavaScriptPython

GET /ekyc/admin/{userId}/status HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "timestamp": "2026-02-13T01:36:04.682Z",
  "total_sessions": 1,
  "verification": {
    "status": "started",
    "reason": "text",
    "timestamp": "2026-02-13T01:36:04.682Z"
  },
  "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"
    }
  }
}