All requests must first be Authorized and must use the HTTP GET method over HTTPS.
This call allows you to get details of a consumer that is assigned to your account in DigitalHub.
https://api.vision-net.ie/cws/2.3/digital_hub/consumer/{{consumerId}}
URI parameters
| Parameter | Type | Description |
|---|---|---|
| consumerId | Integer | Pk of a consumer you get in https://api.vision-net.ie/cws/2.3/digital_hub/consumer/list |
Sample response - json:
FIELDS' REFERENCE
| FIELD NAME | FIELD DESCRIPTION |
|---|---|
| pk | A unique ID generated by VisionNet, and used for subsequent API calls |
| refno | Your unique ID for a person |
| firstName | The person's first name |
| lastName | The person's surname |
| dateOfBirth | Date of birth in ISO format of YYYY-MM-DD |
| placeOfBirth | A string for where they were born (city or country preferred) |
| country | The word of the person's country |
| address | The person's main address |
| phone | The person's main phone number |
| Where to send EIDV and Link2Bank Open Banking requests | |
| positiveFaceCheck | If the person's ID matched their live selfie, this will be 1 |
| cciState | Credit Check Individual (CCI) check's state |
| eidvState | Electronic ID Verification (EIDV) check's state |
| pepState | Politically Exposed Person (PEP) and Sanctions check' state |
| l2bState | Link To Bank status |
| customParameters | A number of additional data points that can be stored against a person. |
| parameterPk | PK for existing parameter type |
| parameterName | Parameter name for existing parameter type |
| parameterType | Parameter type code for existing parameter type |
| parameterDescription | Parameter description for existing parameter type |
| valuePk | Parameter value pk if You want to edit an existing parameter assigned for the customer |
| valueOwnerPk | PK of the value's owner |
| valueOwnerType | The word for the entity of the value's owner |
| value | Parameter value |
| eidvReportDetails | EIDV's check report details |
| applicantId | internal ID code of the applicant |
| customerApplicationId | internal ID code of the customer's application |
| eidvStatus | Electronic ID Verification (EIDV) check' status |
| eidvStatusManual | Parameter describing the current action taken by a human (if necessary) in EIDV check's proccess |
| logDate | The date of the log presented in ISO format of yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
| phyonStatus | the status of the phyon proccess |
| avgCompareScore | The average comparision score |
| faceComparisonResult | Either true or false. Determinds if the selfie matches the person ID's photo |
| selfie | The person's uploaded selfie |
| uploadDate | Date and time of a file's upload in ISO format of yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
| fileSize | The size of a file |
| documentPage1 | the front of the ID document |
| documentPage2 | the back of the ID document |
| proofOfIncome | the proof of income document |
| proofOfAddress | the proof of address document |
| uploaded files | All files uploaded to the system |
| filePk | PK of the existing file |
| fileType | Format of the file |
| fileLabel | The word for the type of the file's label |
| insertedDate | Date of the insertion of the file in ISO format of yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
| fileContentType | Either the BANK_STATEMENT, UTILITY_BILL, PROOF_OF_ADDRESS, PROOF_OF_INCOME, CARD_DETAILS or OTHER |
EIDV STATUS
| STATUS | DESCRIPTION |
|---|---|
| SENT | An EIDV request has been sent to the data subject |
| ERROR | There was an error in the back-end systems |
| PSEUDOLINK_USED | The data subject has clicked the EIDV link and landed on IDVerify.ie. This is a very short-lived status, as the user is almost immediately forwarded to our EIDV platform. |
| OUTDATED | Our EIDV supplier has a 24 hour timeout on links. We silently generate new links in the background, up to 7 days. This status is not likely to be seen by our API calls. |
| REDIRECTED_TO_PHYON | The data subject has now been forwarded to our EIDV platform. |
| COMPLETED | The data subject has completed the EIDV flow. The report is NOT yet ready (see FINISHED). |
| COMPLETED_WITH_ERROR | The data subject had an issue during the EIDV flow, and did not get to the end. The report is NOT yet ready. |
| FINISHED | The images have been gathered, compiled and verified, and the EIDV report is now available. |
| FINISHED_WITH_ERROR | The EIDV report is ready, but an issue has been found which requires human verification. |
| REJECTED_BY_CUSTOMER | The data subject has chosen the opt-out link, and does not want to participate. |
| MANUAL_UPLOAD | The EIDV documentation was uploaded manually, without our fraud and automatic face-recognition systems. |
EIDV STATE's coloured
| STATE | DESCRIPTION | ICON COLOUR ON Vision-Net.ie |
|---|---|---|
| NOT_RUN | An EIDV request has not been requested from this data subject | Grey |
| DETAILS_REQUESTED | An EIDV request has been sent to this data subject | Orange |
| COMPLETED | The EIDV report is ready | Green |
| MANUALLY_ACCEPTED | An employee has reviewed the EIDV Report, and decided the selfie matches the ID. | Green |
| REVIEW_RESULTS | The EIDV report is ready, but an issue has been found which requires human verification. | Red |
| MANUALLY_REJECTED | An employee has reviewed the EIDV Report, and decided the selfie does not match the ID. | Red |
| MANUALLY_UPLOADED | The EIDV documentation was uploaded manually, without our fraud and automatic face-recognition systems. | Red |
| REJECTED_BY_CUSTOMER | The data subject has chosen the opt-out link, and does not want to participate. | Red |
| EXPIRED | The record has passed its expiration date. By default this is one month, but can be extended to one year (rolling) if you have a DigitalHub subscription | White |