Person identification number

Applies to these Dynamics 365 apps:
Human Resources

This article describes the Person identification number entity for Dynamics 365 Human Resources.

Physical name: mshr_hcmpersonidentificationnumberentity

Description

This entity describes the identification numbers for the candidate. It enables the API consumer to write identification numbers, like Social Security numbers or passport numbers, to the candidate record. Identification numbers are surfaced on the worker record, but not on the candidate record. An integrating application can write the values to the Human Resources database, but the numbers won’t be visible in Human Resources until the candidate's worker record is created.

JSON representation

{
    "mshr_entrytype": "String",
    "mshr_description": "String",
    "mshr_expirationdate": "Datetime",
    "mshr_isprimary": Int,
    "mshr_identificationnumber": "String",
    "mshr_partynumber": "String",
    "mshr_identificationtypeid": "String",
    "mshr_issuingagencyid": "String",
    "mshr_primaryfield": "String",
    "_mshr_fk_person_id_value": "Guid",
    "_mshr_fk_issuingagency_id_value": "Guid",
    "_mshr_fk_identificationtype_id_value": "Guid",
    "mshr_hcmpersonidentificationnumberentityid": "Guid",
    "mshr_issueddate": "Datetime"
}

Properties

Property Physical name Type	Use	Description
Person Identification Number Entity ID mshr_hcmpersonidentificationnumberentityid GUID	Read-only Required System-generated	Unique primary identifier for the person identification number record.
Entry Type mshr_entrytype String	Read-write Optional	Free value to reference the type of entry for the identification number.
Description mshr_description String	Read-write Optional	The description of the identification number.
Expiration Date mshr_expirationdate Datetime	Read-write Optional	The date on which the identification number or associated document expires.
Is Primary mshr_isprimary mshr_noyes option set	Read-write Optional	Defines whether the identification number is the primary record for the person for this identification type.
Identification Number mshr_identificationnumber String	Read-write Required	The identification number.
Party Number mshr_partynumber String	Read-write Required	The identifier of the party (person) owning the identification number.
Person ID Value _mshr_fk_person_id_value GUID	Read-only Required Foreign key: mshr_dirpersonentityid of mshr_dirpersonentity entity	The unique identifier of the party (person).
Identification Type ID mshr_identificationtypeid String	Read-write Required	The type of identification number.
Identification Type ID Value _mshr_fk_identificationtype_id_value GUID	Read-only Required Foreign key: mshr_hcmidentificationtypeentityid of mshr_hcmidentificationtypeentity entity	System-generated unique identifier of the identification type.
Issuing Agency ID mshr_issuingagencyid String	Read-write Optional	The agency or organization issuing the identification number.
Issuing Agency ID Value _mshr_fk_issuingagency_id_value GUID	Read-only Optional Foreign key: mshr_hcmissuingagencyentityid of mshr_hcmissuingagencyentity entity	System-generated unique identifier of the agency issuing the identification number.
Primary Field mshr_primaryfield String	Read-only Required	Field to be used as an identifier of the entity record. Combination of party number, identification type ID, and identification number.
Issue Date mshr_issuedate Date	Read-write Optional	The date the identification number was issued.

See also

Applicant Tracking System integration API introduction
Example query for Candidate to hire