person.issuedIdentifier.create

Create an IssuedIdentifier for a Person entity to capture any unique identification issued number and details.

POST http://api.kompliant.com/person.issuedIdentifier.create (OpenAPI specification)

Usage Info

The Person IssuedIdentifier feature assigns unique identifiers (e.g., medical licenses) to a Person. Each identifier is linked to one person and enforces type uniqueness. Use this during onboarding or when registering stakeholders who require official identification.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

ParameterTypeRequiredDescription
person_idstringYesThe identifier of Person Entity to associate with.
issued_identifierobjectNoThe 'issued_identifier' parameter is defined in the tables below.

IssuedIdenfifer Parameter

ParameterTypeRequiredDescription
typeenumyesThe type of identifier issued (e.g., medical_license).
issued_numberstringyesThe official identifier number assigned to the person.

Example

{
  "person_id": "p_57WfSCnafMnxDiWMKcy3EW",
  "issued_identifier": {
    "type": "MEDICAL_LICENSE",
    "issued_number": "MED098AB566"
  }
}

Response

Data

ParameterTypeDescription
issued_identifierobjectThe issued identifier parameter defined in the tables below.

Person Parameters

ParameterTypeDescription
issued_identifier_idstringThe identifier for the IssuedIdentifier just created.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_3XsPP17u8mU3k29x944ygx",
    "version": "2025-03-24"
  },
  "data": {
    "issued_identifier": {
      "issued_identifier_id": "pii_4PYsekjAX8VMuAOfmW81C7"
    }
  }
}

Errors

Error CodeHTTP CodePossible Cause
BAD_REQUEST400Required parameters not provided.
ENTITY_NOT_FOUND400The person_id provided does not exist.
SYSTEM_RULE_VIOLATION400System rule violations are described below

System Rule Violations

When a SYSTEM_RULE_VIOLATION error occurs, the response will include additional entity_type and sub_code fields to provide more specific information:

Entity TypeSub-codeDescription
PersonINVALID_ISSUED_IDENTIFIER_TYPEThe type provided is not one of the PERSON_ISSUED_IDENTIFIER_TYPES .
Invalid value provided.
PersonDUPLICATED_ISSUED_IDENTIFIERThe issued identifier type already exists for the Person entity.