Skip to main content
GET
cURL
Retrieves the latest KYB (Know Your Business) verification details for a business user. Use this to check verification status and retrieve business profile data.

Important Notes

  • The sessionUrl field contains a URL to resume an in-progress KYB session, if available.
  • KYB status values: NOT_STARTED, IN_PROGRESS, VERIFIED, REJECTED, REVIEW_NEEDED.

Use Cases

  • Verification status check: Determine whether a business user has completed KYB before allowing transactions.
  • Resume verification: Use sessionUrl to redirect users with an in-progress session.

Error Codes

Common Errors

User Ownership Errors

Endpoint-Specific Errors

Authorizations

partner-api-key
string
header
required

API key for the affiliated partner performing the request.

Query Parameters

userId
string
required

The user ID

Example:

"2a119021-ed39-4ab4-8690-db610c53f0fb"

Response

Returns the KYB (Know Your Business) verification details for the user.

status
string
Example:

"ok"

data
object