Get identity type

GET 
/IdentityTypes/:identityTypeCode

Get identity type

Request

Path Parameters

identityTypeCode stringrequired

The identity type code.

Responses

200

The identity type with the specified identity type code.

application/json

Schema

Schema

identityTypeTitle stringnullablerequired

The display title of the identity document type.

identityTypeCode stringnullablerequired

The code identifying the type of identity document.

createInfo object

Audit metadata capturing who created this record and when.

actionBy stringnullablerequired

The username or identifier of the user who performed the action.

actionAt date-timerequired

The date and time when the action was performed.

updateInfo object

Audit metadata capturing who last updated this record and when.

actionBy stringnullablerequired

The username or identifier of the user who performed the action.

actionAt date-timerequired

The date and time when the action was performed.

Example (from schema)

{
  "identityTypeTitle": "string",
  "identityTypeCode": "string",
  "createInfo": {
    "actionBy": "string",
    "actionAt": "2024-07-29T15:51:28.071Z"
  },
  "updateInfo": {
    "actionBy": "string",
    "actionAt": "2024-07-29T15:51:28.071Z"
  }
}

304

The identity type has not changed since the date given in the If-Modified-Since HTTP header.

404

An identity type with the specified identity type code could not be found.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Loading...