About consent

Understand your obligation to obtain consent from customers before verifying their information.

When performing an identity check, many sources require that you gain consent from your customers to access certain data. This is most common with credit and government sources. There will be a need to speak with your AML team and the FrankieOne team to determine what consent flags you need to supply.

KvpKeyKvpTypeKvpValueNotes
consent.generalgeneral.booltrue or falseThis indicates that the entity has given consent for their name/address/DoB to be checked against our various databases and external services.
consent.docsgeneral.booltrue or falseThis indicates that the entity has given consent to have their identity documents checked against official sources
consent.creditheadergeneral.booltrue or falseThis indicates that the entity has given permission to have their details checked against a credit bureau service. If this check fails, you must inform the user that the check failed and put them in touch with the bureau directly so that they may update their details as necessary. This isn’t normally available by default, so please see your account manager about making this service available
consent.under18general.booltrue or falseThis indicates that the entity is under the age of 18 and a parent or guardian has provided consent. This is a special case of the consent.general flag (see above). consent.docs would still be required to check their passports/drivers licence.
consent.payrollgeneral.booltrue or falseThis consent is used to allow access to verifying an identity using payroll data
consent.insurancegeneral.booltrue or falseThis consent is used to allow access to verifying an identity using workcover data
consent.superannuationgeneral.booltrue or falseThis consent is used to allow access to verifying an identity using superannuation data
Consents are Important

Where consent is critical or required by law, then you MUST obtain it from your customers, and MUST set it before requesting our service.

If that isn’t done, then it would be noticed that the service doesn’t attempt you use those consented sources, or rejects the verification request altogether.

Please speak with the FrankieOne customer success team if you’re unsure about your options.

Please ensure consent is passed through in the entity extra data area

1{
2    "entity": {
3        "addresses": [
4            {
5                "country": "CAN",
6                "postalCode": "K1A0A1",
7                "state": "ON",
8                "streetNumber": "1416",
9                "streetName": "Huffine Ln.",
10                "town": "Ottowa",
11                "longForm": "1416 Huffine Ln."
12            }
13        ],
14              "identityDocs": [
15   {
16      "country" : "CAN",
17      "idNumber" : "+3435569999",
18      "idType" : "MSISDN"
19    }],
20        "dateOfBirth": {
21            "dateOfBirth": "1957-08-17"
22        },
23        "entityProfile": "standard_kyc",
24        "extraData": [
25            {
26                "kvpKey": "customer_reference",
27                "kvpType": "id.external",
28                "kvpValue": "CANADA-00212312"
29            },
30            {
31                "kvpKey": "consent.general",
32                "kvpType": "general.bool",
33                "kvpValue": "true"
34            },
35            {
36                "kvpKey": "consent.docs",
37                "kvpType": "general.bool",
38                "kvpValue": "true"
39            },
40            {
41                "kvpKey": "consent.creditheader",
42                "kvpType": "general.bool",
43                "kvpValue": "true"
44            }
45        ],
46        "name": {
47            "familyName": "Canada",
48            "middleName": "",
49            "givenName": "Test",
50            "displayName" : "Test Canada"
51        }
52    }
53}
Built with