Create a User Record Type

post/public/v1/user-record-types

post/public/v1/user-record-types

curl --request POST \
  --url 'https://api.app.astalty.com.au/public/v1/user-record-types' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "expires": true,
  "required": true,
  "requires_documents": true,
  "is_self_service": true,
  "requires_verification": true,
  "upload_guideline": "string",
  "description": "string",
  "required_for_user_groups": [
    {
      "id": "string"
    }
  ],
  "template_name": "comprehensive_car_insurance"
}'

Response

{
  "data": {
    "id": "rt1a2b3c-d4e5-6f7a-8b9c-0d1e2f3a4b5c",
    "name": "Police Check",
    "expires": true,
    "required": true,
    "requires_documents": true,
    "requires_verification": false,
    "is_self_service": false,
    "upload_guideline": "<p>Upload a scan of both sides of the certificate.</p>",
    "description": "<p>Required for all staff working with participants.</p>",
    "template_name": "police_check",
    "archived_at": "2024-06-01T00:00:00+00:00",
    "created_at": "2024-01-15T10:30:00+00:00",
    "required_for_user_groups": [
      {
        "id": "u1g2r3p4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
        "name": "Support Workers"
      }
    ]
  }
}

Authorization

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

Body

application/json

namestringrequiredmax length 255
expiresboolean
requiredboolean
requires_documentsboolean
is_self_serviceboolean
requires_verificationboolean
upload_guidelinestring | nullmax length 65535
Limited to 65535 bytes.
descriptionstring | nullmax length 65535
Limited to 65535 bytes.
required_for_user_groupsobject[]max items 5000
▶Show 1 child attributesHide child attributes
- idstringrequired
template_nameenum<string> | null
Available options:comprehensive_car_insurancedrivers_licenseemployment_contractfirst_aid_certificatendis_worker_screening_checkpolice_checkposition_descriptionprimary_id_documentsupport_worker_inductionworking_with_children_check

Response

200application/json

App.PublicApi.V1.UserRecordTypes.UserRecordTypeResource

dataobjectrequired
▶Show 13 child attributesHide child attributes
- idstringrequired
  Example:rt1a2b3c-d4e5-6f7a-8b9c-0d1e2f3a4b5c
- namestringrequired
  Example:Police Check
- expiresbooleanrequired
  Example:true
- requiredbooleanrequired
  Example:true
- requires_documentsbooleanrequired
  Example:true
- requires_verificationbooleanrequired
  Example:false
- is_self_servicebooleanrequired
  Example:false
- upload_guidelinestring | nullrequired
  Example:<p>Upload a scan of both sides of the certificate.</p>
- descriptionstring | nullrequired
  Example:<p>Required for all staff working with participants.</p>
- template_nameenum<string> | nullrequired
  Available options:comprehensive_car_insurancedrivers_licenseemployment_contractfirst_aid_certificatendis_worker_screening_checkpolice_checkposition_descriptionprimary_id_documentsupport_worker_inductionworking_with_children_check
- archived_atstring | nullrequired
  Example:2024-06-01T00:00:00+00:00
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- required_for_user_groupsobject[]required
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:u1g2r3p4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  namestringrequired
  Example:Support Workers

Errors

401Unauthenticated
403Authorization error
422Validation error