Contact for Identity Verification
GET {{baseUrl}}/cas/contactsVerification/events/{{requestId}}/contacts/{{contactId}}
Returns a contact by the given contact ID
Scopes Required
- identity_provider
Response Body
Returns a list of objects that will contain a combination of the below keys
| Key | Datatype | Comments |
|---|---|---|
| contact | Object | See below |
| requestFirm | String | Unique ID of Firm |
| requestUser | String | Email Address of User making the request |
Contact Object
| Key | Datatype | Comments |
|---|---|---|
| address | Object | See address below |
| birthDetails | Object | See birthDetails below |
| citizenship | Object | See citizenship below |
| consent | boolean | This indicates that the CAS 360 user has verified that the contact has given consent to proceed with the verification check. |
| driversLicence | Object | |
| firstName | String | First Name of the person |
| id | String | contactId |
| lastName | String | Last Name or Surname of the person |
| middleName | String | Middle Name of the person |
| gender | String | Gender of the person |
| passport | Object | See passport Object below |
| PEPCheckRequired | Boolean | If True, a PEP check required by the provider. |
| type | String | should be equal to People |
| reference | String | Reference value entered by the user to help identify the event. Max 255 characters. |
Address Object
| Key | Datatype | Comments |
|---|---|---|
| block | String | Only used if country = Singapore or Hong Kong |
| buildingEstate | String | Only used if country = Singapore or Hong Kong |
| country | String | Yes |
| levelFloor | String | Only used if country = Singapore or Hong Kong |
| postcode | String | |
| suburb | String | |
| state | String | Only used if country = Australia |
| streetLine1 | String | |
| streetLine2 | String | |
| suburb | String | |
| townCity | String | |
| unitFlat | String | Only used if country = Singapore or Hong Kong |
birthDetails Object
| Key | Datatype | Comments |
|---|---|---|
| birthCountry | String | ISO 3166 country code/name https://en.wikipedia.org/wiki/ISO_3166 e.g AU |
| birthDate | Date | format = yyyy-MM-dd |
| birthPlace | String | |
| birthState | String | |
| nationality | String | ISO 3166 country code/name https://en.wikipedia.org/wiki/ISO_3166 e.g AU |
citizenship Object
| Key | Datatype | Comments |
|---|---|---|
| acquisitionDate | Date | format = yyyy-MM-dd |
| country | String | ISO 3166 country code/name https://en.wikipedia.org/wiki/ISO_3166 e.g AU |
| firstName | String | |
| lastName | String | Last Name or Surname of the person |
| middleName | String | |
| number | String |
driversLicence Object
| Key | Datatype | Comments |
|---|---|---|
| country | Issuing Country. String | ISO 3166 country code/name https://en.wikipedia.org/wiki/ISO_3166 e.g AU |
| expiryDate | Date | format = yyyy-MM-dd |
| firstName | String | |
| issueDate | Date | format = yyyy-MM-dd |
| lastName | String | Last Name or Surname of the person |
| middleName | String | |
| number | String | Driver's Licence Number |
| cardNumber | String | If ID type is an NSW, ACT, SA, TAS, WA, NT Drivers License, for ID verification there is an additional card number field. |
| version | String | e.g. 012 |
passport Object
| Key | Datatype | Comments |
|---|---|---|
| country | Issuing Country. String | ISO 3166 country code/name https://en.wikipedia.org/wiki/ISO_3166 e.g AU |
| expiryDate | Date | format = yyyy-MM-dd |
| firstName | String | |
| gender | String | either Mor F |
| issueDate | Date | format = yyyy-MM-dd |
| lastName | String | Last Name or Surname of the person |
| middleName | String | |
| number | String | Passport Number |
communicationDetails Object
| Key | Datatype | Comments |
|---|---|---|
| string | Contact's email address | |
| mobile | string | Contact's mobile number |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
"{\n \"contact\": {\n \"address\": {\n \"block\": null,\n \"buildingEstate\": null,\n \"careOf\": \"\",\n \"country\": null,\n \"levelFloor\": null,\n \"postcode\": \"3187\",\n \"state\": \"VIC\",\n \"streetLine1\": \"606 Hawthorn Road\",\n \"streetLine2\": \"\",\n \"suburb\": \"BRIGHTON EAST\",\n \"townCity\": \"BRIGHTON EAST\",\n \"unitFlat\": null\n },\n \"birthDetails\": {\n \"birthCountry\": \"AU\",\n \"birthDate\": \"1987-12-25\",\n \"birthPlace\": \"Macdeon\",\n \"birthState\": \"VIC\"\n \"nationality\": \"AU\"\n },\n \"citizenship\": {\n \"acquisitionDate\": \"1990-07-06\",\n \"country\": \"JM\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"middleName\": null,\n \"number\": \"88454525545654584\"\n },\n \"consent\",\n \"driversLicence\": {\n \"country\": \"AU\",\n \"expiryDate\": \"2024-07-22\",\n \"firstName\": \"John\",\n \"issueLocation\": \"ViC\",\n \"lastName\": \"Doe\",\n \"middleName\": null,\n \"number\": \"4448882521\"\n \"cardNumber\": \"123456789\"\n \"version\": \"012\"\n },\n \"firstName\": \"John\",\n \"id\": 1178270,\n \"lastName\": \"Doe\",\n \"middleName\": null,\n \"gender\":\"M\",\n \"passport\": {\n \"country\": \"AUSTRALIA\",\n \"expiryDate\": \"2028-08-06\",\n \"firstName\": \"John\",\n \"gender\": \"M\",\n \"issueDate\": \"2021-08-06\",\n \"lastName\": \"Doe\",\n \"middleName\": null,\n \"number\": \"444555222\",\n },\n \"communicationDetails\" {\n \"email\": \"john@doe.com.au\",\n \"mobile\": \"+6123123123\"\n },\n \"pepCheckRequired\": true,\n \"type\": \"People\"\n \"reference\": \"ref123\"\n },\n \"requestFirm\": \"apitesting\",\n \"requestUser\": null\n}"