BAbanqzinc
Onboarding

Get onboarding readiness report for a merchant across all providers

Changed on

Get onboarding readiness report for a merchant across all providers

get/api/v1/merchants/{merchantId}/onboarding

Request

Path parameters

merchantIdstring uuid required

The unique identifier of the merchant

Example:123e4567-e89b-12d3-a456-426614174000

Response

Success

successboolean required

Indicates if the request was successful

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
          }
        ]
      }
    ]
  }
}

Changes