Onboarding

7 endpoints, of which 3 need no token.

Paths are relative to the base URL for your environment. Unless marked otherwise, every request needs an Authorization: Bearer header.

GET/onboarding/draft

Asserted by the API’s own test suite.

draft

PUT/onboarding/draft

json

{
  "step": "company_info",
  "data": {
    "companyName": "Test Company",
    "dotNumber": "1234567"
  }
}

Asserted by the API’s own test suite.

ok

DELETE/onboarding/draft

Asserted by the API’s own test suite.

ok

POST/onboarding/setup

json

{
  "companyName": "Test Company LLC",
  "dotNumber": "1234567"
}

Asserted by the API’s own test suite.

organizationId

POST/onboarding/send-codeNo token required

json

{
  "email": "test@example.com",
  "username": "testuser"
}

Asserted by the API’s own test suite.

successsignature

POST/onboarding/verify-codeNo token required

json

{
  "email": "test@example.com",
  "username": "testuser",
  "code": "123456",
  "signature": "{{verification_signature}}"
}

Asserted by the API’s own test suite.

successcognitoConfirmed

POST/onboarding/submitNo token required

json

{
  "organizationId": "{{organization_id}}"
}

Asserted by the API’s own test suite.

successorganizationId