KYC

Endpoints related to KYC verification sessions

Create a KYC verification session

post

Creates a new verification session for the user if no active session exists.

Body

application/json

userIdstringRequired

User identifier for whom to create the verification session

Example: user_1234567890abcdef

Responses

201

Verification session successfully created

application/json

400

Missing user id

application/json

409

Active verification session already exists

application/json

500

Internal server error

application/json

post

/api/kyc/create-verification-session

HTTPcURLJavaScriptPython

POST /api/kyc/create-verification-session HTTP/1.1
Host: platform.madra.finance
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "userId": "user_1234567890abcdef"
}

{
  "message": "Session created",
  "verificationSession": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Get KYC verification session

get

Fetches existing verification session and updates the verification status.

Query parameters

userIdstringRequired

User identifier to fetch session

Example: user_1234567890abcdef

Responses

200

Verification session found and updated

application/json

400

Missing userId query parameter

application/json

404

No active session found for the user

application/json

500

Internal server error

application/json

get

/api/kyc/get-verification-session

HTTPcURLJavaScriptPython

GET /api/kyc/get-verification-session?userId=user_1234567890abcdef HTTP/1.1
Host: platform.madra.finance
Accept: */*

{
  "verificationSession": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}