OnboardingOnboarding

Get onboarding status

get/v1/merchants/{merchantId}/onboarding

Returns the merchant's onboarding record: section statuses, verification tier, the onboarding link, any outstanding missing details, and one merged list of onboarding errors. The errors list combines three sources (legacy errors, missing details and payment provider KYC errors) and keeps only the first occurrence of each field. Returns data: {} when the merchant has no onboarding record. The merchant must belong to your reseller, otherwise 404.

Endpoint destination URL

https://sandbox-portal.datmanlabs.com/api/v1/merchants/{merchantId}/onboarding

Authorization

ApiKeyAuth
headerapi_key<token>

Partner API key issued by Datman.

Request Parameters

Path Parameters

merchantId*integer

Numeric merchant id. Must be a positive integer belonging to your reseller.

Range1 <= value

Response parameters & Errors

Response Body

Onboarding status, or an empty object when there is no onboarding record.

application/json
  1. response
data*

Onboarding record. Every listed property is present when the merchant has an onboarding record. Otherwise the object is empty.