Show a Participant Record

get/public/v1/participant-records/{participantRecord}

get/public/v1/participant-records/{participantRecord}

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/participant-records/{participantRecord}' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": {
    "id": "r1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
    "name": "Police Check",
    "reference": "REF-12345",
    "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",
    "participant": {
      "id": "p1a2r3t4-e5f6-47a8-9b0c-1d2e3f4a5b6c",
      "full_name": "John Doe"
    },
    "record_type": {
      "id": "rt1a2b3c-d4e5-6f7a-8b9c-0d1e2f3a4b5c",
      "name": "Police Check"
    }
  }
}

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

participantRecordstringrequired
The participant record UUID

Response

200application/json

ParticipantRecordResource

dataobjectrequired
▶Show 10 child attributesHide child attributes
- idstringrequired
  Example:r1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b
- namestring | nullrequired
  Example:Police Check
- referencestring | nullrequired
  Example:REF-12345
- statusenum<string>required
  Available options:archivedcurrentexpiredmissing
- 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
- participantobjectrequired
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:p1a2r3t4-e5f6-47a8-9b0c-1d2e3f4a5b6c
  full_namestringrequired
  Example:John Doe
- record_typeobjectrequired
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:rt1a2b3c-d4e5-6f7a-8b9c-0d1e2f3a4b5c
  namestringrequired
  Example:Police Check

Errors

401Unauthenticated
403Authorization error
404Not found