Test a payslip that you registered (sandbox)

POST

/v1/issuer-test/verifications/payload

curl --request POST \
  --url https://verify.sandbox.verifiabl.io/v1/issuer-test/verifications/payload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "barcode": "https://v.verifiabl.io/v/n5waC35dPCoRtMXW5_gJqw#2.JVSWY3DPO5XXE3DE" }'

• Sandbox

Use this operation in sandbox to test the payslips that your organisation registered. Get a Verifier API token with your Issuer API client ID and client secret. Set scope to verifiabl:issuer-test. Verifiabl does not charge for this operation. This operation is not available in production.

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

Scanned barcode

object

barcode

required

string

>= 1 characters <= 13000 characters

Examples

QR code scan URL

{
  "barcode": "https://v.verifiabl.io/v/n5waC35dPCoRtMXW5_gJqw#2.JVSWY3DPO5XXE3DE"
}

PDF metadata payload

{
  "barcode": "2|n5waC35dPCoRtMXW5_gJqw|JVSWY3DPO5XXE3DE"
}

Responses

200

The payslip is verified.

Media typeapplication/json

object

verified

required

boolean

verifiabl_reference

required

string

>= 22 characters <= 22 characters /^[A-Za-z0-9_-]+$/

payslip

required

object

key

additional properties

employee

required

object

key

additional properties

decrypted_at

required

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$/

Examples

ExampleVerified

Verified Australian payslip

{
  "verified": true,
  "verifiabl_reference": "n5waC35dPCoRtMXW5_gJqw",
  "employee": {
    "employee_name": "Ana Leota",
    "position": "Senior Developer",
    "department": "Engineering",
    "employer_identity": "12 345 678 901",
    "bsb": "062-000",
    "account_number": "12345678",
    "account_name": "A Leota",
    "address": "12 Example St, Sydney NSW 2000"
  },
  "payslip": {
    "schema": "au.payslip.v2",
    "issued_at": "2026-04-04T00:00:00.000Z",
    "payslip_non_pii": {
      "period_start": "2026-03-21",
      "period_end": "2026-04-03",
      "payment_date": "2026-04-04",
      "currency": "AUD",
      "pay_frequency": "fortnightly",
      "gross": "4153.85",
      "taxable_gross": "3953.85",
      "paygw": "911.00",
      "net": "3077.35",
      "ytd_gross": "83077.00",
      "ytd_paygw": "18220.00",
      "earnings": [
        {
          "type": "ordinary",
          "amount": "3738.43",
          "ytd_amount": "82661.58"
        },
        {
          "type": "paid_leave",
          "leave_type": "other_paid_leave",
          "units": "7.6",
          "rate": "54.66",
          "amount": "415.42"
        }
      ],
      "salary_sacrifice": [
        {
          "type": "super",
          "amount": "200.00"
        }
      ],
      "deductions": [
        {
          "type": "other_post_tax",
          "amount": "45.50"
        }
      ],
      "superannuation": [
        {
          "contribution_type": "superannuation_guarantee",
          "amount": "498.46",
          "rate": "12",
          "usi": "STA0100AU"
        },
        {
          "contribution_type": "salary_sacrifice",
          "amount": "200.00"
        }
      ],
      "reimbursements": "80.00",
      "employment_basis": "full_time",
      "engagement_type": "permanent",
      "award": "Professional Employees Award 2020 Level 3",
      "base_rate": {
        "amount": "108000.00",
        "per": "year"
      },
      "ytd": {
        "taxable": "79077.00",
        "super": "9969.20",
        "non_taxable": "1600.00",
        "post_tax_deductions": "910.00",
        "reimbursements": "1600.00"
      }
    }
  },
  "decrypted_at": "2026-06-09T09:10:11.123Z"
}

400

The request is invalid, or the payload cannot be decrypted. A DECRYPTION_FAILED response contains reason: no_key_matched, or one of invalid_utf8, p2_invalid_prefix, p2_field_count, p2_control_or_format_character, profile_invalid_prefix, profile_schema_mismatch, profile_field_count, profile_control_or_format_character.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: VALIDATION_FAILED DECRYPTION_FAILED

reason

string

detail

string

field_errors

Array<object>

object

path

required

string

message

required

string

Examples

The request is invalid, or the payload cannot be decrypted. A DECRYPTION_FAILED response contains reason: no_key_matched, or one of invalid_utf8, p2_invalid_prefix, p2_field_count, p2_control_or_format_character, profile_invalid_prefix, profile_schema_mismatch, profile_field_count, profile_control_or_format_character.

{
  "error": "Validation failed",
  "code": "VALIDATION_FAILED"
}

The request is invalid, or the payload cannot be decrypted. A DECRYPTION_FAILED response contains reason: no_key_matched, or one of invalid_utf8, p2_invalid_prefix, p2_field_count, p2_control_or_format_character, profile_invalid_prefix, profile_schema_mismatch, profile_field_count, profile_control_or_format_character.

{
  "error": "Decryption failed",
  "code": "DECRYPTION_FAILED"
}

401

The bearer token is missing or invalid.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: UNAUTHORIZED

reason

string

detail

string

field_errors

Array<object>

object

path

required

string

message

required

string

Examples

ExampleUnauthorized

The bearer token is missing or invalid.

{
  "error": "Unauthorized",
  "code": "UNAUTHORIZED"
}

403

The token does not have the verifiabl:issuer-test scope, or another organisation registered the payslip. For another organisation’s payslip, the response contains reason: issuer_mismatch.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: FORBIDDEN

reason

string

detail

string

field_errors

Array<object>

object

path

required

string

message

required

string

Examples

ExampleForbidden

Another organisation registered the payslip

{
  "error": "This record was not registered by your organisation",
  "code": "FORBIDDEN",
  "reason": "issuer_mismatch"
}

404

Verifiabl has no record of this payslip, or the operation is not available in this environment.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: VERIFIABL_REFERENCE_NOT_FOUND NOT_FOUND

reason

string

detail

string

field_errors

Array<object>

object

path

required

string

message

required

string

Examples

Verifiabl has no record of this payslip, or the operation is not available in this environment.

{
  "error": "Record not found for the provided Verifiabl reference",
  "code": "VERIFIABL_REFERENCE_NOT_FOUND"
}

Verifiabl has no record of this payslip, or the operation is not available in this environment.

{
  "error": "Not found",
  "code": "NOT_FOUND"
}

413

The JSON request body exceeds the route limit.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: PAYLOAD_TOO_LARGE

reason

string

detail

string

field_errors

Array<object>

object

path

required

string

message

required

string

Examples

ExamplePayload Too Large

The JSON request body exceeds the route limit.

{
  "error": "Request body too large",
  "code": "PAYLOAD_TOO_LARGE"
}

415

The request Content-Type is not supported.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: UNSUPPORTED_MEDIA_TYPE

reason

string

detail

string

field_errors

Array<object>

object

path

required

string

message

required

string

Examples

ExampleUnsupported Media Type

The request Content-Type is not supported.

{
  "error": "Unsupported media type",
  "code": "UNSUPPORTED_MEDIA_TYPE"
}

422

No live decryption key is available for the record.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: KEY_VERSION_UNAVAILABLE

reason

string

detail

string

field_errors

Array<object>

object

path

required

string

message

required

string

Examples

ExampleKey Version Unavailable

No live decryption key is available for the record.

{
  "error": "Decryption is not available for this record",
  "code": "KEY_VERSION_UNAVAILABLE",
  "detail": "Contact support."
}

429

Too many test requests for your organisation.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: RATE_LIMITED

reason

string

detail

string

field_errors

Array<object>

object

path

required

string

message

required

string

Examples

ExampleRate Limited

Too many test requests for your organisation.

{
  "error": "Too many requests",
  "code": "RATE_LIMITED",
  "detail": "Retry after the rate limit resets."
}

Headers

Retry-After

required

integer

<= 9007199254740991

Seconds to wait before retrying.

Example

60

500

An unexpected internal error occurred.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: INTERNAL_ERROR

reason

string

detail

string

field_errors

Array<object>

object

path

required

string

message

required

string

Examples

ExampleInternal Error

An unexpected internal error occurred.

{
  "error": "Internal server error",
  "code": "INTERNAL_ERROR"
}

503

A required service dependency or configuration is unavailable.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: SERVICE_UNAVAILABLE

reason

string

detail

string

field_errors

Array<object>

object

path

required

string

message

required

string

Examples

ExampleService Unavailable

A required service dependency or configuration is unavailable.

{
  "error": "Service temporarily unavailable",
  "code": "SERVICE_UNAVAILABLE",
  "detail": "Please retry with exponential backoff."
}

Headers

Retry-After

required

integer

<= 9007199254740991

Seconds to wait before retrying.

Example

5