person.issuedIdentifier.update
Update an IssuedIdentifier for a Person entity to modify any unique identification issued number and details.
POST http://api.kompliant.com/person.issuedIdentifier.update (OpenAPI specification)
Usage Info
The Person IssuedIdentifier feature allows updating details of a unique identifier (e.g., medical license) assigned to a Person. Use this to correct or change official identification information for audit, compliance, or stakeholder management.
Request
Authentication: KSig1-HMAC-SHA256
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| issued_identifier_id | string | Yes | The identifier of the IssuedIdentifier to update. |
| issued_identifier | object | No | The 'issued_identifier' parameter is defined in the tables below. |
IssuedIdenfifer Parameter
| Parameter | Type | Required | Description |
|---|---|---|---|
| type | enum | No | The type of identifier issued (e.g., medical_license). |
| issued_number | string | No | The official identifier number assigned to the person. |
Example
{
"person_id": "p_57WfSCnafMnxDiWMKcy3EW",
"issued_identifier": {
"type": "MEDICAL_LICENSE",
"issued_number": "MED098AB566"
}
}
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. |
| SYSTEM_RULE_VIOLATION | 400 | System 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 Type | Sub-code | Description |
|---|---|---|
| Person | INVALID_ISSUED_IDENTIFIER_TYPE | The type provided is not one of the PERSON_ISSUED_IDENTIFIER_TYPES .Invalid value provided. |
| Person | DUPLICATED_ISSUED_IDENTIFIER | The issued identifier type already exists for the Person entity. |
Updated 6 months ago