Skip to content

On/offboarding Requests

Onboard Integration

Name In Type Required Notes
partner_id path string Yes
Code Meaning
201 Successful Response
422 Validation Error
Terminal window
curl -X POST 'https://<partner-api-host>/<partner_id>/onboarding' \
-H 'apikey: <your-api-key>' \
-H 'Content-Type: application/json' \
-d '{}'

Offboard Integration

Name In Type Required Notes
partner_id path string Yes
Code Meaning
200 Successful Response
422 Validation Error
Terminal window
curl -X POST 'https://<partner-api-host>/<partner_id>/offboarding' \
-H 'apikey: <your-api-key>' \
-H 'Content-Type: application/json' \
-d '{}'