Skip to main content
GET
/
api
/
partner
/
v2
/
kyb
/
details
cURL
curl --request GET \
  --url https://staging-api.capa.fi/api/partner/v2/kyb/details \
  --header 'partner-api-key: <partner-api-key>'
{
  "status": "ok",
  "data": {
    "verificationStatus": "<string>",
    "businessInfo": {
      "businessName": "<string>",
      "countryOfConstitution": "<string>",
      "taxId": "<string>"
    },
    "beneficialOwners": [
      {
        "fullName": "<string>",
        "ownershipPercent": 123
      }
    ],
    "verificationSessionId": "<string>",
    "createdAt": "<string>"
  }
}
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

HTTP StatusCodeMessage
401UNAUTHORIZED”API Key is missing”
401UNAUTHORIZED”Invalid API Key format”
401UNAUTHORIZED”Invalid API Key”
403INVALID_PARTNER_FLOW”The partner has an invalid flow.”

​
User Ownership Errors

HTTP StatusCodeMessage
401UNAUTHORIZED”Partner information is required for this operation”
401UNAUTHORIZED”User is not associated with the partner”

​
Endpoint-Specific Errors

HTTP StatusCodeMessage
404NOT_FOUND_ERROR”Requested KYB verification was not found”
500INTERNAL_SERVER_ERROR”Failed to get user KYB details”

Headers

​
partner-api-key
string
required

Api key for the affiliated partner that is performing the request

Query Parameters

​
userId
string
required

The user ID

Example:

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

Response

200 - application/json
​
status
string
Example:

"ok"

​
data
object