v1
latestOpenAPI 3.1.02026-07-132363652.9 MBOnboarding
Get onboarding readiness report for a merchant across all providers
Get onboarding readiness report for a merchant across all providers
get/api/v1/merchants/{merchantId}/onboarding
Path parameters
merchantIdstring uuid required
The unique identifier of the merchant
Example:123e4567-e89b-12d3-a456-426614174000
The unique identifier of the merchant
Response
Success
Example response
{
"success": true,
"data": {
"merchant_id": "123e4567-e89b-12d3-a456-426614174000",
"providers": [
{
"provider": "quidkey",
"requirements": [
{
"code": "LEGAL_ENTITY_EXISTS",
"label": "Legal entity attached",
"met": true,
"blocker": "Merchant must have a legal entity",
"problems": [
{
"field": "company_name",
"message": "Company name is required"
}
]
}
],
"depends_on": [
{
"provider": "quidkey",
"satisfied": true
}
]
}
]
}
}