v1

latestOpenAPI 3.0.02026-07-2436163302.7 KB

Get onboarding job status

Used for polling purposes, to collect the job status of an ongoing company or individual creation request. Returns the location of the resource or a list of errors, depending on the outcome of the operation.

get/onboarding/v2/jobs/{id}

Path parameters

idstring required

The identifier of the job

Response

Ok - job status retrieved successfully.

messagestring

Message describing the status of the operation.

statusstring

The status of the asynchronous job. Returns success when the operation has completed.

Example response

{
  "errors": [
    {
      "type": "validation"
    }
  ],
  "status": "success"
}