The Entity Object
An entity represents the data of a person or business we wish to store and (usually) verify.
The structure contains a number of sub elements that map to different attributes, such as name, addresses, date of birth and in the case of businesses, organisational data.
Entities can also hold zero or more Document Objects as well.
These documents can be accessed and manipulated directly inside an entity.
{
"entityId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"entityProfile": "string",
"entityType": "INDIVIDUAL",
"name": {
"displayName": "Jane Cecily Smith",
"familyName": "Smith",
"givenName": "Jane",
"honourific": "Duchess",
"middleName": "Cecily"
},
"dateOfBirth": {
"country": "AUS",
"dateOfBirth": "1978-11-12",
"locality": "Brisbane",
"yearOfBirth": "1978"
},
"addresses": [
{
"addressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"addressType": "RESIDENTIAL1",
"buildingName": "Tower of Babel",
"careOf": "string",
"country": "TST",
"endDate": "2021-09-12",
"longForm": "42a Test Eagle Road, Testville, TST 123-TST, Testalia",
"postalCode": "123-TST",
"region": "Test County",
"startDate": "2021-09-12",
"state": "TS",
"streetName": "Test Eagle West",
"streetNumber": "42a",
"streetType": "Road",
"suburb": "Testburb",
"town": "Testville",
"unitNumber": "Suite 1006"
}
],
"gender": "F",
"extraData": [
{
"kvpKey": "Extra.Information",
"kvpType": "general.string",
"kvpValue": "123-456-789A"
}
],
"identityDocs": [
{
"country": "AUS",
"createdFromScan": "true",
"docScan": [
{
"ScanDelete": true,
"scanCreated": "2020-06-02",
"scanData": "VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==",
"scanDataRetrievalState": "NORMAL",
"scanDocId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"scanFilename": "Important Document - ID1234567.pdf",
"scanMIME": "application/pdf",
"scanPageNum": 1,
"scanSide": "F",
"scanType": "PDF"
}
],
"documentId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"documentStatus": "DOC_SCANNED",
"extraData": [
{
"kvpKey": "Extra.Information",
"kvpType": "general.string",
"kvpValue": "123-456-789A"
}
],
"idExpiry": "2020-02-01",
"idIssued": "1972-11-04",
"idNumber": "123456789",
"idSubType": "string",
"idType": "DRIVERS_LICENCE",
"manuallyModified": "false",
"region": "VIC"
}
]
}
Updated 9 months ago