Get onboarding status

GET

/onboarding/{onboardingId}/status

Code sample: Shell / cURL

curl --request GET \
  --url https://welcome.ztlpay.io/onboarding/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/status \
  --header 'Authorization: Bearer <token>'

• Production environment
• Sandbox environment for testing

Authorizations

• OAuth2Sandbox
  api://ac0d1aea-5e3a-463f-9dd1-194898ee5820/.default
• OAuth2Production
  api://1f115cad-5576-4db9-a7f9-8921c47a86e4/.default

Parameters

Path Parameters

onboardingId

required

string format: uuid

Responses

200

Onboarding status fetched successfully

Media typeapplication/json

object

status

required

In production, ManualHandling is only available for Norway.

string

Allowed values: Created AwaitingCustomerAction Processing ManualHandling Accepted Rejected

signingStatus

object

onboardingSigningStatus

required

string

Allowed values: Signed PartiallySigned Unsigned

signers

Array<object>

object

name

required

string

personalNumber

string | null

status

required

string

Allowed values: Signed Unsigned

signingUrl

string | null

documentSignature

object

signatureMethod

string | null

fullName

string | null

firstName

string | null

lastName

string | null

middleName

string | null

signedTime

string | null

dateOfBirth

string | null

Examples

ExamplepartiallySignedTwoSigners

Partially signed onboarding with two signers

{
  "status": "AwaitingCustomerAction",
  "signingStatus": {
    "onboardingSigningStatus": "PartiallySigned",
    "signers": [
      {
        "name": "John Doe",
        "personalNumber": "01019012345",
        "status": "Signed",
        "documentSignature": {
          "signatureMethod": "BANKID_NO",
          "fullName": "John Doe",
          "firstName": "John",
          "lastName": "Doe",
          "middleName": null,
          "signedTime": "2026-01-03T22:57:23",
          "dateOfBirth": "1990-01-01"
        }
      },
      {
        "name": "Jane Smith",
        "personalNumber": null,
        "status": "Unsigned",
        "signingUrl": "https://www.google.com",
        "documentSignature": null
      }
    ]
  }
}

Headers

ztl-request-id

string format: uuid

Unique RequestId, please provide this Id in case of support requests

Example

3a797348-ef0c-4f52-b821-fdfcdb98c4d9

400

Bad request

Media typeapplication/json

object

ztlRequestId

required

Unique RequestId, please provide this Id in case of support requests

string format: uuid

message

required

The underlying reason for the error

string

Example

{
  "ztlRequestId": "3a797348-ef0c-4f52-b821-fdfcdb98c4d9",
  "message": "Invalid account"
}

Headers

ztl-request-id

string format: uuid

Unique RequestId, please provide this Id in case of support requests

Example

3a797348-ef0c-4f52-b821-fdfcdb98c4d9

403

Forbidden

Media typeapplication/json

object

ztlRequestId

required

Unique RequestId, please provide this Id in case of support requests

string format: uuid

message

required

The underlying reason for the error

string

Example

{
  "ztlRequestId": "3a797348-ef0c-4f52-b821-fdfcdb98c4d9",
  "message": "Invalid account"
}

Headers

ztl-request-id

string format: uuid

Unique RequestId, please provide this Id in case of support requests

Example

3a797348-ef0c-4f52-b821-fdfcdb98c4d9

404

Not found

500

Internal server error

Media typeapplication/json

object

ztlRequestId

required

Unique RequestId, please provide this Id in case of support requests

string format: uuid

message

required

The underlying reason for the error

string

Example

{
  "ztlRequestId": "3a797348-ef0c-4f52-b821-fdfcdb98c4d9",
  "message": "Invalid account"
}

Headers

ztl-request-id

string format: uuid

Unique RequestId, please provide this Id in case of support requests

Example

3a797348-ef0c-4f52-b821-fdfcdb98c4d9

503

Service unavailable

Media typeapplication/json

object

ztlRequestId

required

Unique RequestId, please provide this Id in case of support requests

string format: uuid

message

required

The underlying reason for the error

string

Example

{
  "ztlRequestId": "3a797348-ef0c-4f52-b821-fdfcdb98c4d9",
  "message": "Invalid account"
}

Headers

ztl-request-id

string format: uuid

Unique RequestId, please provide this Id in case of support requests

Example

3a797348-ef0c-4f52-b821-fdfcdb98c4d9