Get Onboarding Configuration Page

API for getting onboarding configuration pages for the merchant, this API creates Onboarding Page Model

API Interface

Getting onboarding pages

POST /api/partners/onboarding/pages/:merchant_uid

This API creates new onboarding request based on the fields below.

Path Parameters

Name	Type	Description
merchant_uid*	String	The merchant unique identifier (uid) which you can get after on boarding process is completed successfully by usin on boarding status API

Headers

Name	Type	Description
Authorization*	String	Auth token from auth/token API

Request Body

Name	Type	Description
sessionTimeoutMinutes	number	The number of minutes the session will be valid for the merchant to use

200: OK OK

See Onboarding entity schema: # onboarding-entity

{
    "uid": "52c8e55d-26dc-4935-9214-e3fccf6c8bcf",
    "url": "https://partner.sandbox.sensepass.com/partnersOnBoarding/52c8e55d-26dc-4935-9214-e3fccf6c8bcf",
    "status": "Pending"
}

400: Bad Request Invalid Input

{
    "statusCode": 400,
    "message": [
        "category should not be empty"
    ],
    "error": "Bad Request"
}

500: Internal Server Error Internal Error

{
    // Response
}

Examples

Basic request example to get onboarding pages:

{
	"sessionTimeoutMinutes": 30
}