Usage Info

The Person IssuedIdentifier feature allows retrieval of a unique identifier (e.g., medical license) assigned to a Person. Use this to fetch official identification details for audit, compliance, or stakeholder verification.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
issued_identifier_id	string	Yes	The identifier of the IssuedIdentifier to retrieve.

Example

{
  "issued_identifier_id": "pii_57WfSCnafMnxDiWMKcy3EW"
}

Response

Data

Parameter	Type	Description
issued_identifier	object	The issued identifier parameter defined in the tables below.

Person Parameters

Parameter	Type	Description
issued_identifier_id	string	The identifier for the IssuedIdentifier just created.
type	enum	The type of identifier issued (e.g., medical_license.
person_id	string	The identifier of the associated Person entity.
issued_number	string	The official identifier number assigned to the person.
created_at	string	The date-time when the Person IssuedIdentifier was created. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).
updated_at	string	The date-time when the Person IssuedIdentifier was last updated. If there has been no update, the value will be the same as the created_at value. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_3XsPP17u8mU3k29x944ygx",
    "version": "2025-03-24"
  },
  "data": {
    "issued_identifier": {
      "issued_identifier_id": "pii_4PYsekjAX8VMuAOfmW81C7",
      "type": "MEDICAL_LICENSE",
      "issued_number": "MED098AB566",
      "person_id": "p_57WfSCnafMnxDiWMKcy3EW"
    }
  }
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided.
ENTITY_NOT_FOUND	400	The `issued_identifier_id` provided does not exist.