POST api/iidentifii/GetIdentity

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
IDNumber		string	None.

Request Formats

application/json, text/json

Sample:

{
  "IDNumber": "sample string 1"
}

application/xml, text/xml

Sample:

<initDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iidentifiiAPI.Models">
  <IDNumber>sample string 1</IDNumber>
</initDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IdentityResponse

Name	Type	Additional information
Identity	Identity	None.
Message	string	None.
Error	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Identity": {
    "ID": "48037fbb-fa6b-46f4-b892-d01899a5376c",
    "IdentifyRequestID": "d7c26c1e-e18b-4156-b2ed-6f3aaca89c84",
    "isValid": true,
    "DocumentNumber": "sample string 4",
    "FirstName": "sample string 5",
    "Initials": "sample string 6",
    "Surname": "sample string 7",
    "IdentityNumber": "sample string 8",
    "IDSeqNo": "sample string 9",
    "SmartCardIssued": true,
    "IDIssueDate": "sample string 10",
    "DeadIndicator": true,
    "IDNBlocked": true,
    "MaritalStatus": "sample string 11",
    "DateOfMarriage": "sample string 12",
    "OnHANIS": true,
    "OnNPR": true,
    "BirthPlaceCountryCode": "sample string 13",
    "LivenessFRMatch": true,
    "LivenessFRScore": 1.0,
    "isAlive": true,
    "DHAFRMatch": true,
    "DHAFRScore": 1.0,
    "DHALivenessFRMatch": true,
    "DHALivenessFRScore": 1.0,
    "Triangulated": true,
    "TaxonomyPassed": true,
    "DocumentType": 1,
    "Activated": true,
    "DocumentCountryCode": "sample string 16",
    "DeclaredNumber": "sample string 17",
    "PassportNumber": "sample string 18",
    "IdentityImages": [
      {
        "ID": "c25be144-8d19-466f-9918-b5b31d127a85",
        "IdentityID": "f65c43c4-76d7-4e58-b1e8-7bf199ec4dcb",
        "ImageTypeID": "8a26d8fa-760e-45c5-b12b-377465952112",
        "Image": "QEA=",
        "ImageType": {
          "ID": "60ed392f-092f-444f-9bc0-60dac6785dce",
          "Description": "sample string 2"
        }
      },
      {
        "ID": "c25be144-8d19-466f-9918-b5b31d127a85",
        "IdentityID": "f65c43c4-76d7-4e58-b1e8-7bf199ec4dcb",
        "ImageTypeID": "8a26d8fa-760e-45c5-b12b-377465952112",
        "Image": "QEA=",
        "ImageType": {
          "ID": "60ed392f-092f-444f-9bc0-60dac6785dce",
          "Description": "sample string 2"
        }
      }
    ],
    "IdentityDocumentMetadatas": [
      {
        "ID": "4d43ebe6-0389-434b-a6fc-48ce09dcf6fe",
        "IdentityID": "bc6dfd24-56ec-41ef-a0e0-cd9f302f388c",
        "Metadata": "sample string 3"
      },
      {
        "ID": "4d43ebe6-0389-434b-a6fc-48ce09dcf6fe",
        "IdentityID": "bc6dfd24-56ec-41ef-a0e0-cd9f302f388c",
        "Metadata": "sample string 3"
      }
    ],
    "IdentityAddresses": [
      {
        "ID": "fcb9c862-b353-475d-8957-3126eeba99a0",
        "IdentityID": "c83beebc-7c1c-4c22-8d20-8fcb952ae5c0",
        "Address": "sample string 3",
        "LastUpdatedDate": "2026-06-13T03:50:13.0076733+02:00",
        "BuildingLine": "sample string 4",
        "BoxLine": "sample string 5",
        "StreetLine": "sample string 6",
        "StreetNumber": "sample string 7",
        "StreetName": "sample string 8",
        "Suburb": "sample string 9",
        "Town": "sample string 10",
        "PostCode": "sample string 11",
        "Province": "sample string 12",
        "Country": "sample string 13",
        "AddressType": "sample string 14",
        "Latitude": 1.0,
        "Longitude": 1.0,
        "FirstDate": "2026-06-13T03:50:13.0232995+02:00",
        "RecordDate": "2026-06-13T03:50:13.0232995+02:00",
        "Score": 1.0
      },
      {
        "ID": "fcb9c862-b353-475d-8957-3126eeba99a0",
        "IdentityID": "c83beebc-7c1c-4c22-8d20-8fcb952ae5c0",
        "Address": "sample string 3",
        "LastUpdatedDate": "2026-06-13T03:50:13.0076733+02:00",
        "BuildingLine": "sample string 4",
        "BoxLine": "sample string 5",
        "StreetLine": "sample string 6",
        "StreetNumber": "sample string 7",
        "StreetName": "sample string 8",
        "Suburb": "sample string 9",
        "Town": "sample string 10",
        "PostCode": "sample string 11",
        "Province": "sample string 12",
        "Country": "sample string 13",
        "AddressType": "sample string 14",
        "Latitude": 1.0,
        "Longitude": 1.0,
        "FirstDate": "2026-06-13T03:50:13.0232995+02:00",
        "RecordDate": "2026-06-13T03:50:13.0232995+02:00",
        "Score": 1.0
      }
    ]
  },
  "Message": "sample string 1",
  "Error": true
}

application/xml, text/xml

Sample:

<IdentityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iidentifiiAPI.Models">
  <Error>true</Error>
  <Identity>
    <Activated>true</Activated>
    <BirthPlaceCountryCode>sample string 13</BirthPlaceCountryCode>
    <DHAFRMatch>true</DHAFRMatch>
    <DHAFRScore>1</DHAFRScore>
    <DHALivenessFRMatch>true</DHALivenessFRMatch>
    <DHALivenessFRScore>1</DHALivenessFRScore>
    <DateOfMarriage>sample string 12</DateOfMarriage>
    <DeadIndicator>true</DeadIndicator>
    <DeclaredNumber>sample string 17</DeclaredNumber>
    <DocumentCountryCode>sample string 16</DocumentCountryCode>
    <DocumentNumber>sample string 4</DocumentNumber>
    <DocumentType>1</DocumentType>
    <FirstName>sample string 5</FirstName>
    <ID>48037fbb-fa6b-46f4-b892-d01899a5376c</ID>
    <IDIssueDate>sample string 10</IDIssueDate>
    <IDNBlocked>true</IDNBlocked>
    <IDSeqNo>sample string 9</IDSeqNo>
    <IdentifyRequestID>d7c26c1e-e18b-4156-b2ed-6f3aaca89c84</IdentifyRequestID>
    <IdentityAddresses>
      <IdentityAddress>
        <Address>sample string 3</Address>
        <AddressType>sample string 14</AddressType>
        <BoxLine>sample string 5</BoxLine>
        <BuildingLine>sample string 4</BuildingLine>
        <Country>sample string 13</Country>
        <FirstDate>2026-06-13T03:50:13.0232995+02:00</FirstDate>
        <ID>fcb9c862-b353-475d-8957-3126eeba99a0</ID>
        <IdentityID>c83beebc-7c1c-4c22-8d20-8fcb952ae5c0</IdentityID>
        <LastUpdatedDate>2026-06-13T03:50:13.0076733+02:00</LastUpdatedDate>
        <Latitude>1</Latitude>
        <Longitude>1</Longitude>
        <PostCode>sample string 11</PostCode>
        <Province>sample string 12</Province>
        <RecordDate>2026-06-13T03:50:13.0232995+02:00</RecordDate>
        <Score>1</Score>
        <StreetLine>sample string 6</StreetLine>
        <StreetName>sample string 8</StreetName>
        <StreetNumber>sample string 7</StreetNumber>
        <Suburb>sample string 9</Suburb>
        <Town>sample string 10</Town>
      </IdentityAddress>
      <IdentityAddress>
        <Address>sample string 3</Address>
        <AddressType>sample string 14</AddressType>
        <BoxLine>sample string 5</BoxLine>
        <BuildingLine>sample string 4</BuildingLine>
        <Country>sample string 13</Country>
        <FirstDate>2026-06-13T03:50:13.0232995+02:00</FirstDate>
        <ID>fcb9c862-b353-475d-8957-3126eeba99a0</ID>
        <IdentityID>c83beebc-7c1c-4c22-8d20-8fcb952ae5c0</IdentityID>
        <LastUpdatedDate>2026-06-13T03:50:13.0076733+02:00</LastUpdatedDate>
        <Latitude>1</Latitude>
        <Longitude>1</Longitude>
        <PostCode>sample string 11</PostCode>
        <Province>sample string 12</Province>
        <RecordDate>2026-06-13T03:50:13.0232995+02:00</RecordDate>
        <Score>1</Score>
        <StreetLine>sample string 6</StreetLine>
        <StreetName>sample string 8</StreetName>
        <StreetNumber>sample string 7</StreetNumber>
        <Suburb>sample string 9</Suburb>
        <Town>sample string 10</Town>
      </IdentityAddress>
    </IdentityAddresses>
    <IdentityDocumentMetadatas>
      <IdentityDocumentMetadata>
        <ID>4d43ebe6-0389-434b-a6fc-48ce09dcf6fe</ID>
        <IdentityID>bc6dfd24-56ec-41ef-a0e0-cd9f302f388c</IdentityID>
        <Metadata>sample string 3</Metadata>
      </IdentityDocumentMetadata>
      <IdentityDocumentMetadata>
        <ID>4d43ebe6-0389-434b-a6fc-48ce09dcf6fe</ID>
        <IdentityID>bc6dfd24-56ec-41ef-a0e0-cd9f302f388c</IdentityID>
        <Metadata>sample string 3</Metadata>
      </IdentityDocumentMetadata>
    </IdentityDocumentMetadatas>
    <IdentityImages>
      <IdentityImage>
        <ID>c25be144-8d19-466f-9918-b5b31d127a85</ID>
        <IdentityID>f65c43c4-76d7-4e58-b1e8-7bf199ec4dcb</IdentityID>
        <Image>QEA=</Image>
        <ImageType>
          <Description>sample string 2</Description>
          <ID>60ed392f-092f-444f-9bc0-60dac6785dce</ID>
        </ImageType>
        <ImageTypeID>8a26d8fa-760e-45c5-b12b-377465952112</ImageTypeID>
      </IdentityImage>
      <IdentityImage>
        <ID>c25be144-8d19-466f-9918-b5b31d127a85</ID>
        <IdentityID>f65c43c4-76d7-4e58-b1e8-7bf199ec4dcb</IdentityID>
        <Image>QEA=</Image>
        <ImageType>
          <Description>sample string 2</Description>
          <ID>60ed392f-092f-444f-9bc0-60dac6785dce</ID>
        </ImageType>
        <ImageTypeID>8a26d8fa-760e-45c5-b12b-377465952112</ImageTypeID>
      </IdentityImage>
    </IdentityImages>
    <IdentityNumber>sample string 8</IdentityNumber>
    <Initials>sample string 6</Initials>
    <LivenessFRMatch>true</LivenessFRMatch>
    <LivenessFRScore>1</LivenessFRScore>
    <MaritalStatus>sample string 11</MaritalStatus>
    <OnHANIS>true</OnHANIS>
    <OnNPR>true</OnNPR>
    <PassportNumber>sample string 18</PassportNumber>
    <SmartCardIssued>true</SmartCardIssued>
    <Surname>sample string 7</Surname>
    <TaxonomyPassed>true</TaxonomyPassed>
    <Triangulated>true</Triangulated>
    <isAlive>true</isAlive>
    <isValid>true</isValid>
  </Identity>
  <Message>sample string 1</Message>
</IdentityResponse>