Verify a User Record

post/public/v1/user-records/{userRecord}/verify

Marks a record as checked and accepted, and clears any earlier decline. Refuses with a 409 when the record type does not require verification, or when the record has expired or been archived.

Verifying a record that is already verified succeeds and re-stamps who verified it and when, so a 200 means the record is now verified rather than that it was not verified before. Updating a record leaves its verification in place, so this is how a replaced certificate is recorded as checked again.

post/public/v1/user-records/{userRecord}/verify

curl --request POST \
  --url 'https://api.app.astalty.com.au/public/v1/user-records/{userRecord}/verify' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": {
    "id": "r1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
    "name": "Working with Children Check",
    "reference": "REF-67890",
    "status": "current",
    "signature_status": "signed",
    "issue_date": "2024-01-15T00:00:00+00:00",
    "expiry_date": "2025-01-15T00:00:00+00:00",
    "created_at": "2024-01-15T10:30:00+00:00",
    "verified_at": "2024-01-16T09:00:00+00:00",
    "declined_at": "2024-01-16T09:00:00+00:00",
    "decline_reason": "The uploaded document is illegible.",
    "user": {
      "id": "u1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
      "full_name": "Jane Smith"
    },
    "record_type": {
      "id": "rt1a2b3c-d4e5-6f7a-8b9c-0d1e2f3a4b5c",
      "name": "Working with Children Check"
    },
    "verified_by": {
      "id": "u1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
      "full_name": "Jane Smith"
    },
    "declined_by": {
      "id": "u1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
      "full_name": "Jane Smith"
    }
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

userRecordstringrequired
The user record UUID

Response

200application/json

UserRecordResource

dataobjectrequired
▶Show 15 child attributesHide child attributes
- idstringrequired
  Example:r1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b
- namestring | nullrequired
  Example:Working with Children Check
- referencestring | nullrequired
  Example:REF-67890
- statusenum<string>required
  Available options:archivedawaiting-verificationcurrentdeclinedexpiredmissing
- signature_statusenum<string>required
  Available options:awaiting_signaturesnot_requirednot_sentsigned
- issue_datestring | nullrequired
  Example:2024-01-15T00:00:00+00:00
- expiry_datestring | nullrequired
  Example:2025-01-15T00:00:00+00:00
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- verified_atstring | nullrequired
  Example:2024-01-16T09:00:00+00:00
- declined_atstring | nullrequired
  Example:2024-01-16T09:00:00+00:00
- decline_reasonstring | nullrequired
  Example:The uploaded document is illegible.
- userobjectrequired
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:u1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b
  full_namestringrequired
  Example:Jane Smith
- record_typeobjectrequired
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:rt1a2b3c-d4e5-6f7a-8b9c-0d1e2f3a4b5c
  namestringrequired
  Example:Working with Children Check
- verified_byobject | nullrequired
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:u1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b
  full_namestringrequired
  Example:Jane Smith
- declined_byobject | nullrequired
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:u1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b
  full_namestringrequired
  Example:Jane Smith

Errors

401Unauthenticated
403Authorization error
404Not found
409The record type does not require verification, or the record has expired or been archived.