Skip to main content
GET
/
api
/
platform
/
kyb
/
{user_id}
Get KYB of a user
curl --request GET \
  --url http://localhost:8001/api/platform/kyb/{user_id} \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>'
{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "business_name": "<string>",
    "dba": "<string>",
    "business_phone": "<string>",
    "business_email": "<string>",
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>",
    "business_description": "<string>",
    "business_id_type": "<string>",
    "website": "<string>",
    "mcc": "<string>",
    "formation_date": "<string>",
    "entity_type": "<string>",
    "status": "<string>",
    "document_1": "<string>",
    "document_2": "<string>",
    "document_3": "<string>",
    "document_4": "<string>",
    "document_5": "<string>"
  },
  "queryGeneratedTime": 1718006400
}

Headers

​
X-Platform-ID
string<uuid>
required

Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.

​
X-Signature
string
required

HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.

Path Parameters

​
user_id
string<uuid>
required

Unique identifier (UUID) of the user whose KYB record is being retrieved.

Response

Successful Response

​
success
boolean
default:true

Indicates whether the request was processed successfully.

Example:

true

​
message
string
default:Success

A short, human-readable message describing the result of the request.

Example:

"Operation completed."

​
data
PlatformKybRead · object

The main response payload, if applicable

​
queryGeneratedTime
number | null
default:1782303609.673092

The Unix timestamp (in seconds) indicating when the response was generated.

Example:

1718006400