Onboarding status
API for retrieving the current status of a given onboarding.
API Interface
Get Onboarding status object by a onboarding uid
GET
/api/partners/onboarding/{onboarding_uid}
Path Parameters
Onboarding unique identifier
Auth token from auth/token API
See Onboarding Status entity schema: # Onboarding-status-entity
{
"uid": "06a6abb6-5da9-47c0-a35f-dd8db215a8e1",
"status": "Approved",
"message": null,
"merchant": {
"merchant_info": {
"category": "ski",
"city": "abrotzo",
"country": "Italy",
"email": "merchant2@email.com",
"house_number": 100,
"phone_number": "19148759682",
"social_id": "89485712",
"name": "ski and snowboard inc",
"state": "my state",
"street": "very goood thing",
"website": null,
"locale": "USA"
},
"merchant_owner_info": {
"email": "contact@me.com",
"name": "moshe israel",
"phone_number": "1555888999",
"social_id": null
},
"active": true,
"verified": false,
"status": {
"uid": "2",
"name": "Approved"
},
"uid": "27fd4624-2fd5-4b31-ad29-67f1a85e5ec3",
"created": "2023-01-23T09:26:02.548Z",
"displayName": "ski&snowboard",
"logo": null,
"locations": [
{
"active": true,
"verified": false,
"uid": "eca844e7-cc30-438c-ac80-107cbb837cb9",
"created": "2023-01-23T09:26:02.827Z",
"display_name": "my store",
"number": "1",
"apiKey": "usbs5vnwffp3v8on2zrqld2gd60boj2048ixh9ub0zbkwk1pflobxybn"
}
]
}
}
Schema
Full Onboarding Status Entity schema: # Onboarding-status-entity