GET api/applicant/GetClientData?Idn={Idn}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Idn | string |
Required |
Body Parameters
None.
Response Information
Resource Description
PersonProfileResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| fullNameArabic | string |
None. |
|
| fullNameEnglish | string |
None. |
|
| firstNameArabic | string |
None. |
|
| firstNameEnglish | string |
None. |
|
| secondNameArabic | string |
None. |
|
| secondNameEnglish | string |
None. |
|
| thirdNameArabic | string |
None. |
|
| thirdNameEnglish | string |
None. |
|
| fourthNameArabic | string |
None. |
|
| fourthNameEnglish | string |
None. |
|
| khulasitQaidNo | string |
None. |
|
| familyBookNo | string |
None. |
|
| identityCard | IdentityCard |
None. |
|
| gender | Lookup |
None. |
|
| birthDate | date |
None. |
|
| maritalStatus | Lookup |
None. |
|
| passport | Passport |
None. |
|
| nationality | Lookup |
None. |
|
| immigrationFile | ImmigrationFile |
None. |
|
| occupation | Lookup |
None. |
|
| motherNameArabic | string |
None. |
|
| motherNameEnglish | string |
None. |
|
| motherFirstNameArabic | string |
None. |
|
| motherFirstNameEnglish | string |
None. |
|
| localAddress | LocalAddress |
None. |
|
| qualification | Qualification |
None. |
|
| familyCount | integer |
None. |
|
| isExist | boolean |
None. |
|
| Response | ResponseProfilePerson |
None. |
Response Formats
application/json, text/json
Sample:
{
"fullNameArabic": "sample string 1",
"fullNameEnglish": "sample string 2",
"firstNameArabic": "sample string 3",
"firstNameEnglish": "sample string 4",
"secondNameArabic": "sample string 5",
"secondNameEnglish": "sample string 6",
"thirdNameArabic": "sample string 7",
"thirdNameEnglish": "sample string 8",
"fourthNameArabic": "sample string 9",
"fourthNameEnglish": "sample string 10",
"khulasitQaidNo": "sample string 11",
"familyBookNo": "sample string 12",
"identityCard": {
"unifiedNumber": "sample string 1",
"IDN": "sample string 2",
"expiryDate": "2025-11-09T20:36:05.3552985+04:00",
"issueDate": "2025-11-09T20:36:05.3552985+04:00"
},
"gender": {
"id": 1,
"arDesc": "sample string 2",
"enDesc": "sample string 3"
},
"birthDate": "2025-11-09T20:36:05.3552985+04:00",
"maritalStatus": {
"id": 1,
"arDesc": "sample string 2",
"enDesc": "sample string 3"
},
"passport": {
"passportNo": "sample string 1",
"expiryDate": "2025-11-09T20:36:05.3552985+04:00"
},
"nationality": {
"id": 1,
"arDesc": "sample string 2",
"enDesc": "sample string 3"
},
"immigrationFile": {
"status": {
"id": 1,
"arDesc": "sample string 2",
"enDesc": "sample string 3"
},
"department": {
"id": 1,
"arDesc": "sample string 2",
"enDesc": "sample string 3"
},
"expiryDate": "2025-11-09T20:36:05.3552985+04:00"
},
"occupation": {
"id": 1,
"arDesc": "sample string 2",
"enDesc": "sample string 3"
},
"motherNameArabic": "sample string 14",
"motherNameEnglish": "sample string 15",
"motherFirstNameArabic": "sample string 16",
"motherFirstNameEnglish": "sample string 17",
"localAddress": {
"Mobile": "sample string 1",
"homePhone": "sample string 2",
"poboxNo": "sample string 3",
"workPhone": "sample string 4",
"area": {
"id": 1,
"arDesc": "sample string 2",
"enDesc": "sample string 3"
},
"building": "sample string 5",
"street": {
"id": 1,
"arDesc": "sample string 2",
"enDesc": "sample string 3"
},
"city": {
"id": 1,
"arDesc": "sample string 2",
"enDesc": "sample string 3"
},
"emirate": {
"id": 1,
"arDesc": "sample string 2",
"enDesc": "sample string 3"
},
"email": "sample string 6"
},
"qualification": {
"specialization": {
"id": 1,
"arDesc": "sample string 2",
"enDesc": "sample string 3"
},
"grade": "sample string 1"
},
"familyCount": 18,
"isExist": true,
"Response": {
"RefNum": "sample string 1",
"TimeStamp": "2025-11-09T20:36:05.3552985+04:00"
}
}
application/xml, text/xml
Sample:
<PersonProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDF.APIs.Models">
<Response>
<RefNum>sample string 1</RefNum>
<TimeStamp>2025-11-09T20:36:05.3552985+04:00</TimeStamp>
</Response>
<birthDate>2025-11-09T20:36:05.3552985+04:00</birthDate>
<familyBookNo>sample string 12</familyBookNo>
<familyCount>18</familyCount>
<firstNameArabic>sample string 3</firstNameArabic>
<firstNameEnglish>sample string 4</firstNameEnglish>
<fourthNameArabic>sample string 9</fourthNameArabic>
<fourthNameEnglish>sample string 10</fourthNameEnglish>
<fullNameArabic>sample string 1</fullNameArabic>
<fullNameEnglish>sample string 2</fullNameEnglish>
<gender>
<arDesc>sample string 2</arDesc>
<enDesc>sample string 3</enDesc>
<id>1</id>
</gender>
<identityCard>
<IDN>sample string 2</IDN>
<expiryDate>2025-11-09T20:36:05.3552985+04:00</expiryDate>
<issueDate>2025-11-09T20:36:05.3552985+04:00</issueDate>
<unifiedNumber>sample string 1</unifiedNumber>
</identityCard>
<immigrationFile>
<department>
<arDesc>sample string 2</arDesc>
<enDesc>sample string 3</enDesc>
<id>1</id>
</department>
<expiryDate>2025-11-09T20:36:05.3552985+04:00</expiryDate>
<status>
<arDesc>sample string 2</arDesc>
<enDesc>sample string 3</enDesc>
<id>1</id>
</status>
</immigrationFile>
<isExist>true</isExist>
<khulasitQaidNo>sample string 11</khulasitQaidNo>
<localAddress>
<Mobile>sample string 1</Mobile>
<area>
<arDesc>sample string 2</arDesc>
<enDesc>sample string 3</enDesc>
<id>1</id>
</area>
<building>sample string 5</building>
<city>
<arDesc>sample string 2</arDesc>
<enDesc>sample string 3</enDesc>
<id>1</id>
</city>
<email>sample string 6</email>
<emirate>
<arDesc>sample string 2</arDesc>
<enDesc>sample string 3</enDesc>
<id>1</id>
</emirate>
<homePhone>sample string 2</homePhone>
<poboxNo>sample string 3</poboxNo>
<street>
<arDesc>sample string 2</arDesc>
<enDesc>sample string 3</enDesc>
<id>1</id>
</street>
<workPhone>sample string 4</workPhone>
</localAddress>
<maritalStatus>
<arDesc>sample string 2</arDesc>
<enDesc>sample string 3</enDesc>
<id>1</id>
</maritalStatus>
<motherFirstNameArabic>sample string 16</motherFirstNameArabic>
<motherFirstNameEnglish>sample string 17</motherFirstNameEnglish>
<motherNameArabic>sample string 14</motherNameArabic>
<motherNameEnglish>sample string 15</motherNameEnglish>
<nationality>
<arDesc>sample string 2</arDesc>
<enDesc>sample string 3</enDesc>
<id>1</id>
</nationality>
<occupation>
<arDesc>sample string 2</arDesc>
<enDesc>sample string 3</enDesc>
<id>1</id>
</occupation>
<passport>
<expiryDate>2025-11-09T20:36:05.3552985+04:00</expiryDate>
<passportNo>sample string 1</passportNo>
</passport>
<qualification>
<grade>sample string 1</grade>
<specialization>
<arDesc>sample string 2</arDesc>
<enDesc>sample string 3</enDesc>
<id>1</id>
</specialization>
</qualification>
<secondNameArabic>sample string 5</secondNameArabic>
<secondNameEnglish>sample string 6</secondNameEnglish>
<thirdNameArabic>sample string 7</thirdNameArabic>
<thirdNameEnglish>sample string 8</thirdNameEnglish>
</PersonProfileResponse>