Skip to content
Verifiabl
Demo
Download OpenAPI JSON

Register a batch of non-PII payslip records

POST
/v1/registerNonPIIBatch
curl --request POST \
  --url https://register.verifiabl.io/v1/registerNonPIIBatch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "records": [ { "verifiabl_reference": "K3mXq8Rt2pLz9wQv1AYb_w", "external_id": "payslip-84213", "schema": "au.payslip.v1", "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_cents": 360000, "taxable_gross_cents": 340000, "paygw_cents": 75200, "net_cents": 268250, "ytd_gross_cents": 4320000, "ytd_paygw_cents": 902400, "earnings": [ { "type": "ordinary", "units": 76, "rate_cents": 4000, "amount_cents": 304000 }, { "type": "overtime", "units": 4, "rate_cents": 6000, "amount_cents": 24000 }, { "type": "allowance", "allowance_type": "tools", "amount_cents": 4000 }, { "type": "paid_leave", "leave_type": "other_paid_leave", "amount_cents": 28000 } ], "salary_sacrifice": [ { "type": "super", "amount_cents": 20000 } ], "deductions": [ { "type": "other_post_tax", "amount_cents": 4550 } ], "superannuation": [ { "contribution_type": "superannuation_guarantee", "amount_cents": 39840, "usi": "STA0100AU" }, { "contribution_type": "salary_sacrifice", "amount_cents": 20000, "usi": "STA0100AU" } ], "reimbursements_cents": 8000 }, "encryption_metadata": { "iv": "QEFCQ0RFRkdISUpL", "tag": "oKGio6SlpqeoqaqrrK2urw" } } ] }'

Registers up to 1,000 records with ordered per-record outcomes. Record-level validation failures are represented in the successful response.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”

The encryption values in these structural examples are non-submittable placeholders. For each payslip, perform one AES-256-GCM encryption with a fresh, unpredictable 96-bit IV from a cryptographically secure random number generator, then use that operation’s IV and authentication tag together with its ciphertext. Never copy, mix, or reuse the example encryption values.

Media typeapplication/json
object
records
required
Array<object>
>= 1 items <= 1000 items
object
verifiabl_reference
required
string
>= 22 characters <= 22 characters /^[A-Za-z0-9_-]+$/
external_id
string
>= 1 characters <= 255 characters /^[\x20-\x7e]+$/
schema
required
string
>= 1 characters <= 64 characters /^[a-z]{2}\.[a-z]+\.v\d+$/
issued_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))$/
payslip_non_pii
required
object
key
additional properties
encryption_metadata
required
object
iv
required
string
>= 16 characters <= 16 characters /^[A-Za-z0-9_-]+$/
tag
required
string
>= 22 characters <= 22 characters /^[A-Za-z0-9_-]+$/
key_version
string
/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\.[1-9][0-9]{0,5}$/
Examples
ExamplePay Run

One record from a pay run (replace all encryption outputs)

{
  "records": [
    {
      "verifiabl_reference": "K3mXq8Rt2pLz9wQv1AYb_w",
      "external_id": "payslip-84213",
      "schema": "au.payslip.v1",
      "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_cents": 360000,
        "taxable_gross_cents": 340000,
        "paygw_cents": 75200,
        "net_cents": 268250,
        "ytd_gross_cents": 4320000,
        "ytd_paygw_cents": 902400,
        "earnings": [
          {
            "type": "ordinary",
            "units": 76,
            "rate_cents": 4000,
            "amount_cents": 304000
          },
          {
            "type": "overtime",
            "units": 4,
            "rate_cents": 6000,
            "amount_cents": 24000
          },
          {
            "type": "allowance",
            "allowance_type": "tools",
            "amount_cents": 4000
          },
          {
            "type": "paid_leave",
            "leave_type": "other_paid_leave",
            "amount_cents": 28000
          }
        ],
        "salary_sacrifice": [
          {
            "type": "super",
            "amount_cents": 20000
          }
        ],
        "deductions": [
          {
            "type": "other_post_tax",
            "amount_cents": 4550
          }
        ],
        "superannuation": [
          {
            "contribution_type": "superannuation_guarantee",
            "amount_cents": 39840,
            "usi": "STA0100AU"
          },
          {
            "contribution_type": "salary_sacrifice",
            "amount_cents": 20000,
            "usi": "STA0100AU"
          }
        ],
        "reimbursements_cents": 8000
      },
      "encryption_metadata": {
        "iv": "QEFCQ0RFRkdISUpL",
        "tag": "oKGio6SlpqeoqaqrrK2urw"
      }
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200”

The batch was processed.

Media typeapplication/json
object
results
required
Array
One of:
Created
object
status
required
string
Allowed values: created
verifiabl_reference
required
string
>= 22 characters <= 22 characters /^[A-Za-z0-9_-]+$/
external_id
string
>= 1 characters <= 255 characters /^[\x20-\x7e]+$/
Examples
ExampleProcessed

Created, duplicate, and rejected records

{
  "results": [
    {
      "status": "created",
      "verifiabl_reference": "K3mXq8Rt2pLz9wQv1AYb_w",
      "external_id": "payslip-84213"
    },
    {
      "status": "duplicate",
      "verifiabl_reference": "B2nYr7St3qMa0xRw2BdEfg",
      "external_id": "payslip-84214"
    },
    {
      "status": "error",
      "code": "VALIDATION_FAILED",
      "detail": "payslip_non_pii does not conform to au.payslip.v1: net_cents: Invalid input: expected int, received number",
      "verifiabl_reference": "C3oZs8Tu4rNb1ySx3CgHij",
      "external_id": "payslip-84215"
    },
    {
      "status": "error",
      "code": "CONFLICT",
      "detail": "verifiabl_reference already registered with different data",
      "verifiabl_reference": "D4pAt9Uv5sOc2zTy4DhIjk",
      "external_id": "payslip-84216"
    },
    {
      "status": "error",
      "code": "IV_REUSED",
      "detail": "encryption_metadata.iv has already been used by this issuer; re-encrypt the record with a fresh iv",
      "verifiabl_reference": "E5qBu0Vw6tPd3aUz5EiJkl",
      "external_id": "payslip-84217"
    }
  ]
}

400

Section titled “400”

The batch request envelope failed strict validation.

Media typeapplication/json
object
error
required
string
code
required
string
Allowed values: VALIDATION_FAILED
reason
string
detail
string
field_errors
Array<object>
object
path
required
string
message
required
string
Examples
ExampleValidation Failed

The batch request envelope failed strict validation.

{
  "error": "Validation failed",
  "code": "VALIDATION_FAILED",
  "field_errors": [
    {
      "path": "records",
      "message": "records must contain at least one record"
    }
  ]
}

401

Section titled “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

Section titled “403”

The authenticated principal cannot use this operation.

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

The authenticated principal cannot use this operation.

{
  "error": "Forbidden",
  "code": "FORBIDDEN"
}

413

Section titled “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

Section titled “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"
}

429

Section titled “429”

The request exceeded an IP or client rate limit.

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

The request exceeded an IP or client rate limit.

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

Headers

Section titled “Headers”
Retry-After
required
integer
<= 9007199254740991

Seconds to wait before retrying.

Example
60

500

Section titled “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

Section titled “503”

The instance has reached its concurrent batch limit.

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

The instance has reached its concurrent batch limit.

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

Headers

Section titled “Headers”
Retry-After
required
integer
<= 9007199254740991

Seconds to wait before retrying.

Example
5