Argentina - Citizen source

Identity verification - Name, DOB, address, phone and email address

Capabilities

Generic email match result

Indicates if the email has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Initial matches

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Address line 1 match flag

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and (Date of Birth match result is `match` or Date of Birth match result is `partial match`) and (Overall Address match result is `match` or Overall Address match result is `partial match`)	The first name, last name, date of birth, and address all match or partially match.
`Partial Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and ((Date of Birth match result is `match` or Date of Birth match result is `partial match`) or (Overall Address match result is `match` or Overall Address match result is `partial match`))	The first and last names match or partially match, and either the date of birth or address matches or partially matches.
`Could Not Locate`	First Name match result is `not available` and Last Names match result is `not available`	The data source has no record of the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Argentina - Citizen source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	No	The subject’s current residential address.
`DateOfBirth`	Yes	The subject’s date of birth.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`OtherEmails`	No	Any additional email addresses associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Argentina: Single match

Performs a single-source identity verification check for Argentinian subjects. It cross-references the subject’s name, date of birth, and DNI (Documento Nacional de Identidad) number against trusted Argentinian data sources.

Detail	Value
Required inputs	Full name, date of birth, DNI number
Optional inputs	Gender, current address, landline phone, tax identification number

Capabilities

The module returns source-count capabilities that indicate how many independent data sources confirmed each combination of identity elements, plus an age flag and an overall GBG score. This capability structure is shared across most Data Verification variants. Differences between variants are in input requirements and default outcome logic.

Number of matching sources

The total number of independent data sources that returned any type of match for the subject’s submitted information.

Detail	Description
Type	Integer
Range	0–5
Default	`0`

A value of 0 means no data sources matched any combination of the subject’s identity elements. Higher values indicate stronger verification confidence because the identity was confirmed independently across multiple sources.

Name + Address matches

The number of data sources where the subject’s name and address both matched.

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + DOB matches

The number of data sources where the subject’s name and date of birth both matched.

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + DOB + Address matches

The number of data sources where the subject’s name, date of birth, and address all matched. This is the strongest match combination without an ID number and is typically used as the threshold for a full “Match” outcome.

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + Name + Address matches

The number of data sources where the subject’s national ID number, name, and address all matched.

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + Name + DOB matches

The number of data sources where the subject’s national ID number, name, and date of birth all matched.

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + Name + DOB + Address matches

The number of data sources where the subject’s national ID number, name, date of birth, and address all matched. This is the highest-confidence match combination available.

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Is under 18

Indicates whether the subject is under 18 years of age based on the submitted or verified date of birth.

Value	Description
`true`	The subject is under 18. This triggers the `ALERT` outcome in most variants.
`false`	The subject is 18 or older, or age could not be determined. This is the default value.

GBG score

An overall identity verification score calculated by GBG based on the strength and breadth of matches across data sources.

Detail	Description
Type	Integer
Range	0–1000
Default	`0`

Higher scores indicate stronger identity verification confidence. A score of 0 indicates that no meaningful verification data was returned. This score can be used in custom evaluation rules for more granular decisioning beyond the default outcomes.

Default outcomes

The table below lists the default outcomes for this variant.

Outcome	Condition	Description
`ALERT`	Is under 18 is `true`	The subject is under 18. The journey should apply age-appropriate restrictions or route to rejection.
`Match`	Name + DOB + Address ≥ 1 or ID + Name + DOB + Address ≥ 1	The subject’s identity was confirmed by at least one data source matching the strongest element combinations.
`Partial Match`	Name + Address ≥ 1 or Name + DOB ≥ 1 or ID + Name + Address ≥ 1	Some identity elements matched but not the full combination required for a full match. The journey may route to manual review or request additional information.
`No Match`	Name + Address < 1	No data source confirmed even a basic name and address combination.
`Error`	Default (no conditions matched)	An unexpected error occurred during processing.

Input payload

The following is a sample payload used to submit identity data to the Data Verification module for processing.

JSON

{
  "resourceId": "your-journey-resourceID@latest",
  "context": {
    "subject": {
      "identity": {
        "currentAddress": {
          "administrativeArea": "CIUDAD AUTONOMA DE BUENOS AIRES",
          "building": "5 B",
          "country": "ARG",
          "locality": "CIUDAD AUTONOMA DE BUENOS AIRES",
          "postalCode": "1824",
          "thoroughfare": "SUPERI 1405"
        },
        "dateOfBirth": "2020-04-19",
        "firstName": "Alberto Leonel",
        "gender": "M",
        "idNumbers": [
          {
            "country": "ARG",
            "idNumber": "11111111",
            "type": "dniNumber"
          },
          {
            "country": "ARG",
            "idNumber": "11111111111",
            "type": "taxIdentificationNumber"
          }
        ],
        "lastNames": [
          "Turchetto"
        ],
        "phones": [
          {
            "number": "35755501",
            "type": "Landline"
          }
        ]
      },
      "uid": "Test Case 0391-016"
    }
  }
}

Sample response

The following is a sample response returned by the module.

{
  "response": {
    "advice": {
      "customDecision": null,
      "emailMatch": false,
      "gbgScore": 390,
      "idName": 1,
      "idNameAddress": 1,
      "idNameAddressDob": 0,
      "idNameDob": 0,
      "isUnder18": true,
      "nameAddress": 1,
      "nameDob": 0,
      "nameDobAddress": 0,
      "phoneMatch": false,
      "sources": 1
    },
    "outcome": "ALERT"
  }
}

In this example:

One source matched the full ID + Name + Address + DOB combination (idNameAddressDob: 1), which is the strongest match available.
The GBG score is 500, indicating moderate verification confidence.
The subject is 18 or older (isUnder18: false).
The outcome resolves to Match.

Argentina - Single Source

Capabilities

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`no result`	no result

Count of matches against name and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against name, address and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and either address or date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document and name

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document, name, address and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against name and address

Count of mmatches against name and address

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document, name and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and address match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and address and date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources with more than one field match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document, name and address

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	Supplier Decision is `match`	The data source confirms the subject’s identity.
`Partial Identity Match`	Supplier Decision is `partial match`	The data source partially confirms the subject’s identity.
`Identity Mismatch`	Supplier Decision is `mismatch`	The data source returns a mismatch for the subject’s details.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Could Not Locate`	Default, when no conditions matched	The module can’t find a record for the subject in the data source.

Input payload

The following is a sample payload used to submit data to the Argentina - Single Source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "12345678",
          "sortCode": "01-02-03",
          "type": "Bank Account"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Full",
        "idNumbers": [
          {
            "idNumber": "12345678",
            "type": "identityCard"
          }
        ],
        "lastNames": [
          "Match"
        ],
        "middleNames": [
          "Good"
        ],
        "phones": [
          {
            "number": "+447795111111",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	No	The subject’s current residential address.
`DateOfBirth`	No	The subject’s date of birth.
`MobilePhone`	No	The subject’s mobile telephone number.
`WorkPhone`	No	The subject’s work telephone number.
`LandlinePhone`	No	The subject’s landline telephone number.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`IdentityCard`	No	The number of the subject’s national identity card.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Identity Match"
  }
}

Australia - Citizen source

Identity verification - Name, DOB, address, phone and email address

Capabilities

Generic email match result

Indicates if the email has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Initial matches

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Address line 1 match flag

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and (Date of Birth match result is `match` or Date of Birth match result is `partial match`) and (Overall Address match result is `match` or Overall Address match result is `partial match`)	The first name, last name, date of birth, and address all match or partially match.
`Partial Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and ((Date of Birth match result is `match` or Date of Birth match result is `partial match`) or (Overall Address match result is `match` or Overall Address match result is `partial match`))	The first and last names match or partially match, and either the date of birth or address matches or partially matches.
`Could Not Locate`	First Name match result is `not available` and Last Names match result is `not available`	The data source has no record of the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Australia - Citizen source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	No	The subject’s current residential address.
`DateOfBirth`	Yes	The subject’s date of birth.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`OtherEmails`	No	Any additional email addresses associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Australia - Citizenship Certificate

Government database of Australian Citizenship Certificate holders, maintained by the Department of Home Affairs.

Capabilities

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`alert`	alert
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Alert`	Supplier Decision is `alert`	The data source raises an alert for the subject.
`Identity Match`	Supplier Decision is `match`	The data source confirms the subject’s identity.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Australia - Citizenship Certificate module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "documents": [
        {
          "issueDate": "2020-01-01",
          "number": "Abcd12345",
          "type": "citizenshipCertificate"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "A99 9AA",
          "premise": "999",
          "thoroughfare": "Letsby Avenue"
        },
        "dateOfBirth": "2025-01-01",
        "firstName": "Alert",
        "lastNames": [
          "Alert"
        ],
        "phones": [
          {
            "number": "+447700900123",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`FullName/firstName`	No	The subject’s first name.
`FullName/lastNames`	Yes	The subject’s last name or names.
`DateOfBirth`	Yes	The subject’s date of birth.
`AustraliaCitizenshipCertificate`	Yes	The subject’s Australian citizenship certificate, including the certificate number and issue date.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Alert"
  }
}

Australia: Credit Header 1

Data compiled and maintained by Australia Credit Bureau 1 as part of their Consumer Credit Reporting Agency activities.

Detail	Value
Required inputs	Full name, current address, date of birth
Optional inputs	None

Capabilities

The table below lists the capabilities returned by this variant.

Capability	Values	Description
Supplier decision	`match`, `mismatch`, `partial match`, `no result`	The credit bureau’s overall match decision.
Input address quality level	`1`–`4`	Quality of the submitted address.

Default outcomes

The table below lists the default outcomes for this variant.

Outcome	Condition	Description
`Identity Match`	Supplier decision is `match`	Full match confirmed by the credit bureau.
`Partial Identity Match`	Supplier decision is `partial match`	Partial match.
`Identity Mismatch`	Default	The subject could not be verified.
`Error`	—	A system or data source error stopped the check from completing.

Input payload

The following is a sample payload used to submit identity data to the Data Verification module for processing.

JSON

{
  "resourceId": "your-journey-resourceID@latest",
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "12345678",
          "sortCode": "01-02-03",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "111",
          "number": "NZ111111",
          "type": "Driving Licence"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Full",
        "lastNames": [
          "Match"
        ],
        "middleNames": [
          "Good"
        ],
        "phones": [
          {
            "number": "+447795111111",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Sample response

The following is a sample response for a successful identity match.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Identity Match"
  }
}

Australia - Credit Header 2

Data compiled and maintained by Australia Credit Bureau 2 as part of their Consumer Credit Reporting Agency activities.

Capabilities

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	Supplier Decision is `match`	The data source confirms the subject’s identity.
`Partial Identity Match`	Supplier Decision is `partial match`	The data source partially confirms the subject’s identity.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Australia - Credit Header 2 module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "12345678",
          "sortCode": "01-02-03",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "111",
          "number": "NZ111111",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Full",
        "lastNames": [
          "Match"
        ],
        "middleNames": [
          "Good"
        ],
        "phones": [
          {
            "number": "+447795111111",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	No	The subject’s current residential address.
`DateOfBirth`	No	The subject’s date of birth.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Identity Match"
  }
}

Australia: Directors

Australian government database compiled and maintained by the Australian Securities & Investment Commission. This is a list of the names of all directors and their registered addresses for all registered Australian companies.

Detail	Value
Required inputs	Full name, date of birth
Optional inputs	None

Capabilities

The table below lists the capabilities returned by this variant.

Capability	Values	Description
Supplier decision	`match`, `mismatch`, `no result`	The data source’s overall match decision.

Default outcomes

The table below lists the default outcomes for this variant.

Outcome	Condition	Description
`Identity Match`	Supplier decision is `match`	Identity confirmed.
`Identity Mismatch`	Default	The subject could not be verified.
`Error`	—	A system or data source error stopped the check from completing.

Input payload

The following is a sample payload used to submit identity data to the Data Verification module for processing.

JSON

{
  "resourceId": "your-journey-resourceID@latest",
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "12345678",
          "sortCode": "01-02-03",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "111",
          "number": "NZ111111",
          "type": "Driving Licence"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Full",
        "lastNames": [
          "Match"
        ],
        "middleNames": [
          "Good"
        ],
        "phones": [
          {
            "number": "+447795111111",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Sample response

The following is a sample response for a successful identity match.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Identity Match"
  }
}

Australia - Driver Licence

Government database of Australian drivers, maintained by the Australian Document Verification Service - DVS

Capabilities

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`alert`	alert
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Alert`	Supplier Decision is `alert`	The data source raises an alert for the subject.
`Identity Match`	Supplier Decision is `match`	The data source confirms the subject’s identity.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Australia - Driver Licence module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "11111999",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "1234567890",
          "issuingStateCode": "NSW",
          "number": "NZ999999",
          "type": "drivingLicense"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "A99 9AA",
          "premise": "999",
          "thoroughfare": "Letsby Avenue"
        },
        "dateOfBirth": "2025-01-01",
        "firstName": "Alert",
        "lastNames": [
          "Alert"
        ],
        "phones": [
          {
            "number": "+447700900123",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`FullName/firstName`	Yes	The subject’s first name.
`FullName/middleNames`	No	Any additional registered names of the subject.
`FullName/lastNames`	Yes	The subject’s last name or names.
`DateOfBirth`	Yes	The subject’s date of birth.
`AustraliaDrivingLicense`	Yes	The subject’s Australian driver licence, including the licence number, card number, and issuing state.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Alert"
  }
}

Australia - Electoral Roll

Government database of the Australian Electoral Roll, maintained by the Australian Electoral Commission.

Capabilities

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`alert`	alert
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Alert`	Supplier Decision is `alert`	The data source raises an alert for the subject.
`Identity Match`	Supplier Decision is `match`	The data source confirms the subject’s identity.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Australia - Electoral Roll module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "11111999",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "999",
          "number": "NZ999999",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "A99 9AA",
          "premise": "999",
          "thoroughfare": "Letsby Avenue"
        },
        "dateOfBirth": "2025-01-01",
        "firstName": "Alert",
        "lastNames": [
          "Alert"
        ],
        "phones": [
          {
            "number": "+447700900123",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`FullName/firstName`	Yes	The subject’s first name.
`FullName/middleNames`	No	Any additional registered names of the subject.
`FullName/lastNames`	Yes	The subject’s last name or names.
`CurrentAddress`	Yes	The subject’s current residential address.
`CurrentAddress/lines`	No	The full address as one or more free-form lines, used when structured address components are not available.
`CurrentAddress/addressString`	No	The full address as a single line.
`CurrentAddress/premise`	No	The premise (building name or number) of the current address.
`CurrentAddress/building`	No	The building name or number of the current address.
`CurrentAddress/subBuilding`	No	The sub-building (for example, flat or unit) of the current address.
`CurrentAddress/thoroughfare`	No	The street or thoroughfare of the current address.
`CurrentAddress/dependentThoroughfare`	No	The dependent thoroughfare (a smaller street within the thoroughfare) of the current address.
`CurrentAddress/locality`	No	The locality (town or city) of the current address.
`CurrentAddress/dependentLocality`	No	The dependent locality (a smaller area within the locality) of the current address.
`CurrentAddress/doubleDependentLocality`	No	The double dependent locality (a smaller area within the dependent locality) of the current address.
`CurrentAddress/postalCode`	No	The postal or ZIP code of the current address.
`CurrentAddress/postBox`	No	The post office box of the current address.
`CurrentAddress/country`	No	The country of the current address.
`CurrentAddress/superAdministrativeArea`	No	The super-administrative area (a larger region above the administrative area) of the current address.
`CurrentAddress/administrativeArea`	No	The administrative area (for example, state, province, or county) of the current address.
`CurrentAddress/subAdministrativeArea`	No	The sub-administrative area (a smaller region within the administrative area) of the current address.
`CurrentAddress/organization`	No	The company or organization associated with the current address.
`CurrentAddress/location`	No	The geographic location (coordinates) of the current address.
`DateOfBirth`	Yes	The subject’s date of birth.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Alert"
  }
}

Australia - Event Member Data

Data source consisting of personal information on individuals obtained from Event Ticketing. Data is sourced directly from customers at the time of purchase of tickets or at the time of online account creation.

Capabilities

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`no result`	no result
`not available`	not available

Full name match result

Value	Description
`match`	match
`mismatch`	mismatch
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`no result`	no result
`not available`	not available

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	Date of Birth match result is `match` and Overall Address match result is `match` and Full name match result is `match`	The full name, date of birth, and address all match.
`Partial Identity Match`	(Date of Birth match result is `match` or Overall Address match result is `match`) and Full name match result is `match`	The full name matches, and either the date of birth or address matches.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Australia - Event Member Data module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "identity": {
        "currentAddress": {
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Full",
        "lastNames": [
          "Match"
        ],
        "middleNames": [
          "Good"
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`FullName/firstName`	Yes	The subject’s first name.
`FullName/middleNames`	No	Any additional registered names of the subject.
`FullName/lastNames`	Yes	The subject’s last name or names.
`CurrentAddress`	No	The subject’s current residential address.
`CurrentAddress/lines`	No	The full address as one or more free-form lines, used when structured address components are not available.
`CurrentAddress/addressString`	No	The full address as a single line.
`CurrentAddress/premise`	No	The premise (building name or number) of the current address.
`CurrentAddress/building`	No	The building name or number of the current address.
`CurrentAddress/subBuilding`	No	The sub-building (for example, flat or unit) of the current address.
`CurrentAddress/thoroughfare`	No	The street or thoroughfare of the current address.
`CurrentAddress/dependentThoroughfare`	No	The dependent thoroughfare (a smaller street within the thoroughfare) of the current address.
`CurrentAddress/locality`	No	The locality (town or city) of the current address.
`CurrentAddress/dependentLocality`	No	The dependent locality (a smaller area within the locality) of the current address.
`CurrentAddress/doubleDependentLocality`	No	The double dependent locality (a smaller area within the dependent locality) of the current address.
`CurrentAddress/postalCode`	No	The postal or ZIP code of the current address.
`CurrentAddress/postBox`	No	The post office box of the current address.
`CurrentAddress/country`	No	The country of the current address.
`CurrentAddress/superAdministrativeArea`	No	The super-administrative area (a larger region above the administrative area) of the current address.
`CurrentAddress/administrativeArea`	No	The administrative area (for example, state, province, or county) of the current address.
`CurrentAddress/subAdministrativeArea`	No	The sub-administrative area (a smaller region within the administrative area) of the current address.
`CurrentAddress/organization`	No	The company or organization associated with the current address.
`CurrentAddress/location`	No	The geographic location (coordinates) of the current address.
`DateOfBirth`	Yes	The subject’s date of birth.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Identity Match"
  }
}

Australia: Historical Electoral Roll

Derived from the historical Electoral Rolls across Australia, dated pre-2004.

Detail	Value
Required inputs	Full name, current address
Optional inputs	None

Capabilities

The table below lists the capabilities returned by this variant.

Capability	Values	Description
First name match result	`match`, `mismatch`, `initial match`, `partial match`, `no result`	Match result for the subject’s first name.
Middle names match result	`match`, `mismatch`, `no result`, `not available`, `initial match`	Match result for middle name(s).
Last names match result	`match`, `mismatch`, `no result`	Match result for last name.
Overall address match result	`match`, `mismatch`, `partial match`, `no result`	Overall address match result.
Input address quality level	`1`–`4`	Quality of the submitted address.

Default outcomes

The table below lists the default outcomes for this variant.

Outcome	Condition	Description
`Identity Match`	First name is `match` and last name is `match` and address is `match`	All three core elements fully matched.
`Partial Identity Match`	Any of seven qualifying conditions (see below)	Partial verification with various name/address combinations.
`Identity Mismatch`	Default	No verification path produced a passing result.
`Error`	—	A system or data source error stopped the check from completing.

The Partial Identity Match outcome is triggered by any of the following six conditions. Any condition listed as any accepts every possible match result for that field.

First name	Middle names	Last name	Address
`mismatch`	`not available` or `mismatch`	`match`	`match`
`match`	`not available`	`match`	`mismatch` or `partial match`
`mismatch`	`match`	`match`	any
`initial match`	`not available`	`match`	any
`partial match`	`mismatch` or `not available`	`match`	any
`initial match`	`initial match`	`match`	`match`

Input payload

The following is a sample payload used to submit identity data to the Data Verification module for processing.

Replace your-journey-resourceID@latest with your journey’s resource ID. You can find this in the Journey Builder after publishing your journey.

JSON

{
  "resourceId": "your-journey-resourceID@latest",
  "context": {
    "subject": {
      "uid": "variant-test-user",
      "identity": {
        "firstName": "Full",
        "middleNames": ["Good"],
        "lastNames": ["Match"],
        "dateOfBirth": "2007-03-26",
        "currentAddress": {
          "country": "AUS",
          "administrativeArea": "NSW",
          "postalCode": "2000",
          "locality": "Sydney",
          "thoroughfare": "George Street",
          "premise": "1A"
        },
        "phones": [
          {
            "type": "mobile",
            "number": "+61400000000"
          }
        ]
      },
      "accounts": [
        {
          "type": "Bank Account",
          "accountNumber": "12345678",
          "sortCode": "01-02-03"
        }
      ],
      "documents": [
        {
          "type": "Driving Licence",
          "number": "0123456789",
          "cardNumber": "111"
        }
      ]
    }
  }
}

Sample response

The following is a sample response for a successful identity match.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Identity Match"
  }
}

Input payload

The following is a sample payload used to submit data to the Australia - Historical Electoral Roll module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "12345678",
          "sortCode": "01-02-03",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "111",
          "number": "NZ111111",
          "type": "Driving Licence"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Full",
        "lastNames": [
          "Match"
        ],
        "middleNames": [
          "Good"
        ],
        "phones": [
          {
            "number": "+447795111111",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	Yes	The subject’s current residential address.

Australia - Passport

Government database of Australian Passport holders, maintained by the Department of Foreign Affairs and Trade.

Capabilities

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`alert`	alert
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Alert`	Supplier Decision is `alert`	The data source raises an alert for the subject.
`Identity Match`	Supplier Decision is `match`	The data source confirms the subject’s identity.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Australia - Passport module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "11111999",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "number": "NZ9999999",
          "sex": "F",
          "type": "passport"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "A99 9AA",
          "premise": "999",
          "thoroughfare": "Letsby Avenue"
        },
        "dateOfBirth": "2025-01-01",
        "firstName": "Alert",
        "lastNames": [
          "Alert"
        ],
        "phones": [
          {
            "number": "+447700900123",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`FullName/firstName`	No	The subject’s first name.
`FullName/lastNames`	Yes	The subject’s last name or names.
`DateOfBirth`	Yes	The subject’s date of birth.
`AustraliaPassport`	Yes	The subject’s Australian passport, including the passport number and sex recorded on it.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Alert"
  }
}

Australia: Population

This database is a data source that aggregates individual identification data from third-party providers who collect personal information through marketing and lead generation activities.

Detail	Value
Required inputs	Full name, current address, date of birth
Optional inputs	None

Capabilities

The table below lists the capabilities returned by this variant.

Capability	Values	Description
First name match result	`match`, `mismatch`, `no result`, `initial match`	Match result for first name.
Last names match result	`match`, `mismatch`, `no result`	Match result for last name.
Date of birth match result	`match`, `mismatch`, `partial match`, `not available`, `no result`	Match result for DOB.
Overall address match result	`match`, `mismatch`, `not available`, `no result`	Overall address match result.
Input address quality level	`1`–`4`	Quality of the submitted address.

Default outcomes

The table below lists the default outcomes for this variant.

Outcome	Condition	Description
`Identity Match`	First name is `match` and last name is `match` and address is `match` and DOB is `match`	All four elements fully matched.
`Partial Identity Match`	Name and address match but DOB is partial or mismatch, or name and DOB match but address is mismatch	Three of four elements confirmed.
`Identity Mismatch`	Default	The subject could not be verified.
`Error`	—	A system or data source error stopped the check from completing.

Input payload

The following is a sample payload used to submit identity data to the Data Verification module for processing.

Replace your-journey-resourceID@latest with your journey’s resource ID. You can find this in the Journey Builder after publishing your journey.

JSON

{
  "resourceId": "your-journey-resourceID@latest",
  "context": {
    "subject": {
      "uid": "variant-test-user",
      "identity": {
        "firstName": "Full",
        "middleNames": ["Good"],
        "lastNames": ["Match"],
        "dateOfBirth": "2007-03-26",
        "currentAddress": {
          "country": "AUS",
          "administrativeArea": "NSW",
          "postalCode": "2000",
          "locality": "Sydney",
          "thoroughfare": "George Street",
          "premise": "1A"
        },
        "phones": [
          {
            "type": "mobile",
            "number": "+61400000000"
          }
        ]
      },
      "accounts": [
        {
          "type": "Bank Account",
          "accountNumber": "12345678",
          "sortCode": "01-02-03"
        }
      ],
      "documents": [
        {
          "type": "Driving Licence",
          "number": "0123456789",
          "cardNumber": "111"
        }
      ]
    }
  }
}

Sample response

The following is a sample response for a successful identity match.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Identity Match"
  }
}

Input payload

The following is a sample payload used to submit data to the Australia - Population module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "12345678",
          "sortCode": "01-02-03",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "111",
          "number": "NZ111111",
          "type": "Driving Licence"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Full",
        "lastNames": [
          "Match"
        ],
        "middleNames": [
          "Good"
        ],
        "phones": [
          {
            "number": "+447795111111",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	Yes	The subject’s current residential address.
`DateOfBirth`	Yes	The subject’s date of birth.

Australia Residential

Capabilities

Generic email match result

Indicates if the email has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Middle names match result

Indicates if the middle names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Premise match result

Indicates if the current address’ premise has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Thoroughfare match result

Indicates if the current address’ thoroughfare has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Mobile phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	First Name match result is `match` and Last Names match result is `match` and Date of Birth match result is `match` and (Premise match result is `match` and Thoroughfare match result is `match` and (Postal Code match result is `match` or Locality match result is `match`) and Administrative Area match result is `match`)	The first name, last name, and date of birth match. The premise, thoroughfare, administrative area, and postal code or locality also match.
`Partial Identity Match`	First Name match result is `match` and Last Names match result is `match` and (Date of Birth match result is `match` or (Premise match result is `match` and Thoroughfare match result is `match` and (Locality match result is `match` or Postal Code match result is `match` or Administrative Area match result is `match`)))	The first and last names match. Either the date of birth matches, or the premise, thoroughfare, and one more address element match.
`Could Not Locate`	Supplier Decision is `unrecognised value`	The data source returned a decision that the module doesn’t recognise, so the module can’t locate the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Australia Residential module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`MobilePhone`	No	The subject’s mobile telephone number.
`FullName`	Yes	The subject’s full name, including given and family names.
`FullName/firstName`	Yes	The subject’s first name.
`FullName/middleNames`	No	Any additional registered names of the subject.
`FullName/lastNames`	Yes	The subject’s last name or names.
`FullName/title`	No	The subject’s title, for example, Mr, Ms, or Dr.
`DateOfBirth`	No	The subject’s date of birth.
`CurrentAddress`	Yes	The subject’s current residential address.
`CurrentAddress/lines`	No	The full address as one or more free-form lines, used when structured address components are not available.
`CurrentAddress/addressString`	No	The full address as a single line.
`CurrentAddress/premise`	No	The premise (building name or number) of the current address.
`CurrentAddress/building`	No	The building name or number of the current address.
`CurrentAddress/subBuilding`	No	The sub-building (for example, flat or unit) of the current address.
`CurrentAddress/thoroughfare`	No	The street or thoroughfare of the current address.
`CurrentAddress/dependentThoroughfare`	No	The dependent thoroughfare (a smaller street within the thoroughfare) of the current address.
`CurrentAddress/locality`	No	The locality (town or city) of the current address.
`CurrentAddress/dependentLocality`	No	The dependent locality (a smaller area within the locality) of the current address.
`CurrentAddress/doubleDependentLocality`	No	The double dependent locality (a smaller area within the dependent locality) of the current address.
`CurrentAddress/postalCode`	No	The postal or ZIP code of the current address.
`CurrentAddress/postBox`	No	The post office box of the current address.
`CurrentAddress/country`	No	The country of the current address.
`CurrentAddress/superAdministrativeArea`	No	The super-administrative area (a larger region above the administrative area) of the current address.
`CurrentAddress/administrativeArea`	No	The administrative area (for example, state, province, or county) of the current address.
`CurrentAddress/subAdministrativeArea`	No	The sub-administrative area (a smaller region within the administrative area) of the current address.
`CurrentAddress/organization`	No	The company or organization associated with the current address.
`CurrentAddress/location`	No	The geographic location (coordinates) of the current address.
`OtherEmails`	No	Any additional email addresses associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Australia: Single match gov ID source

Performs a single-match identity verification check for Australian subjects against government ID data sources.

Detail	Value
Required inputs	Determined by the registration process
Optional inputs	None

Capabilities

The table below lists the capabilities returned by this variant.

Capability	Type	Values	Description
Overall verification result	Enumset	`VERIFIED`, `IN_PROGRESS`	The overall verification status.
DVS sources remaining	Enumset	Various government ID source identifiers	Government ID sources that have not yet been checked. Informational only. Not used in default outcome logic.

DVS sources

Government ID sources that have not yet been checked. Informational only. Not used in default outcome logic.

Value	Description
`nswregodvs`	NSW Rego DVS
`qldregodvs`	QLD Rego DVS
`actregodvs`	ACT Rego DVS
`ntregodvs`	NT Rego DVS
`tasregodvs`	TAS Rego DVS
`waregodvs`	WA Rego DVS
`vicregodvs`	VIC Rego DVS
`saregodvs`	SA Rego DVS
`medicaredvs`	Medicare
`passportdvs`	Passport
`visadvs`	Visa
`centrelinkdvs`	Centrelink
`birthcertificatedvs`	Birth Certificate
`marriagecertificatedvs`	Marriage Certificate
`changeofnamecertificatedvs`	Change of Certificate
`aec`	Electoral Roll

Default outcomes

The table below lists the default outcomes for this variant.

Outcome	Condition	Description
`Refer`	Overall verification status includes `IN_PROGRESS`	Verification is not yet complete.
`Error`	Default	An unexpected error occurred.

Input payload

The following is a sample payload used to submit identity data to the Data Verification module for processing.

JSON

{
  "resourceId": "your-journey-resourceID@latest",
  "context": {
    "subject": {
      "identity": {
        "title": "Mr.",
        "firstName": "John",
        "middleNames": ["TWOFFFFFFFFFFF"],
        "lastNames": ["Doe"],
        "dateOfBirth": "1980-01-01",
        "gender": "Male",
        "currentAddress": {
          "country": "AU",
          "postalCode": "2617",
          "administrativeArea": "ACT",
          "dependentLocality": "Belconnen",
          "thoroughfareType": "Street",
          "thoroughfare": "Baloney",
          "building": "42"
        }
      },
      "previousAddress": [],
      "phones": [
        {
          "type": "mobile",
          "number": "0420000009"
        }
      ],
      "emails": [
        {
          "type": "personal",
          "email": "john.doe@example.com"
        }
      ],
      "socials": [
        {
          "type": "facebook",
          "identity": "john.doe"
        }
      ]
    }
  }
}

Sample response

The following is a sample response showing verification still in progress.

JSON

{
  "response": {
    "advice": {
      "overallVerificationStatus": "IN_PROGRESS"
    },
    "outcome": "Refer"
  }
}

Australia: Single match standard sources (AML)

One match on any Australian standard sources for AML customers.

Detail	Value
Required inputs	Determined by the registration process
Optional inputs	None

Capabilities

The table below lists the capabilities returned by this variant.

Capability	Type	Values	Description
Overall verification result	Enumset	`VERIFIED`, `IN_PROGRESS`	The overall verification status.
Credit Bureau Check	Enumset	`VERIFIED`, `AUTOFAIL`, `ERROR`, `NOT_CONTRIBUTING`	Result of the credit bureau check. `AUTOFAIL` indicates the credit bureau data contradicted the identity. `NOT_CONTRIBUTING` indicates the credit bureau check did not contribute to the verification decision (e.g. no record found). Not used in default outcome logic but available for custom evaluation rules.

illion credit bureau check

illion Credit Bureau Check

Value	Description
`VERIFIED`	Verified
`AUTOFAIL`	Autofail
`ERROR`	Error
`NOT_CONTRIBUTING`	Not Contributing

Default outcomes

The table below lists the default outcomes for this variant.

Outcome	Condition	Description
`Pass`	Overall verification status includes `VERIFIED`	Identity verified.
`Refer`	Overall verification status includes `IN_PROGRESS`	Verification not yet complete.
`Error`	Default	An unexpected error occurred.

Input payload

The following is a sample payload used to submit identity data to the Data Verification module for processing.

JSON

{
  "resourceId": "your-journey-resourceID@latest",
  "context": {
    "subject": {
      "emails": [
        {
          "email": "john.doe@example.com",
          "type": "personal"
        }
      ],
      "identity": {
        "currentAddress": {
          "administrativeArea": "ACT",
          "building": "42",
          "country": "AU",
          "dependentLocality": "Belconnen",
          "postalCode": "2617",
          "thoroughfare": "Baloney",
          "thoroughfareType": "Street"
        },
        "dateOfBirth": "1980-01-01",
        "firstName": "John",
        "gender": "Male",
        "lastNames": [
          "NameAddressDob"
        ],
        "middleNames": [
          "TWOPASS"
        ],
        "title": "Mr."
      },
      "phones": [
        {
          "number": "0420000009",
          "type": "mobile"
        }
      ],
      "previousAddress": [],
      "socials": [
        {
          "identity": "john.doe",
          "type": "facebook"
        }
      ]
    }
  }
}

Sample response

The following is a sample response for a successful identity verification.

JSON

{
  "response": {
    "advice": {
      "illionStatus": "VERIFIED",
      "overallVerificationStatus": "VERIFIED",
      "sourcesUsed": {
        "AU EMD": "VERIFIED",
        "Credit History": "VERIFIED",
        "Data Co-op": "VERIFIED",
        "GDC Asic Person Name": "VERIFIED",
        "GDC Tenancy File": "VERIFIED",
        "NAD": "VERIFIED",
        "PND": "VERIFIED"
      }
    },
    "export": {
      "sku": [
        "greenID_AU_NZ_govID_platformcharge",
        "greenID_AU_AML"
      ]
    },
    "outcome": "Pass"
  }
}

Australia: Single match standard sources (non-AML)

One match on any Australian standard sources for non-AML customers.

Detail	Value
Required inputs	Determined by the registration process
Optional inputs	None

The capabilities include only the overall verification result (VERIFIED, IN_PROGRESS). Default outcomes are: Pass (verified) / Refer (in progress) / Error (default).

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Pass`	Overall verification result is `VERIFIED`	The data source verifies the subject’s identity.
`Refer`	Overall verification result is `IN_PROGRESS`	The verification is still in progress and needs follow-up.
`Error`	Default, when no conditions matched	An unexpected error occurred, so the module couldn’t return a result.

Input payload

The following is a sample payload used to submit identity data to the Data Verification module for processing.

JSON

{
  "resourceId": "your-journey-resourceID@latest",
  "context": {
    "subject": {
      "emails": [
        {
          "email": "john.doe@example.com",
          "type": "personal"
        }
      ],
      "identity": {
        "currentAddress": {
          "administrativeArea": "ACT",
          "building": "42",
          "country": "AU",
          "dependentLocality": "Belconnen",
          "postalCode": "2617",
          "thoroughfare": "Baloney",
          "thoroughfareType": "Street"
        },
        "dateOfBirth": "1980-01-01",
        "firstName": "John",
        "gender": "Male",
        "lastNames": [
          "Doe"
        ],
        "middleNames": [
          "TWOPASS"
        ],
        "title": "Mr."
      },
      "phones": [
        {
          "number": "0420000009",
          "type": "mobile"
        }
      ],
      "previousAddress": [],
      "socials": [
        {
          "identity": "john.doe",
          "type": "facebook"
        }
      ]
    }
  }
}

Sample response

The following is a sample response for a successful identity verification.

JSON

{
  "response": {
    "advice": {
      "overallVerificationStatus": "VERIFIED",
      "sourcesUsed": {
        "AU EMD": "VERIFIED",
        "Data Co-op": "VERIFIED",
        "GDC Asic Person Name": "VERIFIED",
        "GDC Tenancy File": "VERIFIED",
        "NAD": "VERIFIED",
        "PND": "VERIFIED"
      }
    },
    "export": {
      "sku": [
        "greenID_AU_NZ_govID_platformcharge",
        "greenID_AU_nonAML"
      ]
    },
    "outcome": "Pass"
  }
}

Overall verification result

The overall result will confirm if the verification rule has been met.

Value	Description
`VERIFIED`	Verified
`IN_PROGRESS`	In Progress (not verified)

Australia: Single match standard sources (with additional sources) (AML)

One match on any Australian standard and additional sources for AML customers.

Detail	Value
Required inputs	Determined by the registration process
Optional inputs	None

The capabilities and default outcomes are the same as Australia: Single match standard sources (AML).

Input payload

The following is a sample payload used to submit identity data to the Data Verification module for processing.

JSON

{
  "resourceId": "your-journey-resourceID@latest",
  "context": {
    "subject": {
      "emails": [
        {
          "email": "john.doe@example.com",
          "type": "personal"
        }
      ],
      "identity": {
        "currentAddress": {
          "administrativeArea": "ACT",
          "building": "42",
          "country": "AU",
          "dependentLocality": "Belconnen",
          "postalCode": "2617",
          "thoroughfare": "Baloney",
          "thoroughfareType": "Street"
        },
        "dateOfBirth": "1980-01-01",
        "firstName": "John",
        "gender": "Male",
        "lastNames": [
          "NameAddressDob"
        ],
        "middleNames": [
          "TWOFFFFFFFFFFFFFFFFPFFFFFFFFF"
        ],
        "title": "Mr."
      },
      "phones": [
        {
          "number": "0420000009",
          "type": "mobile"
        }
      ],
      "previousAddress": [],
      "socials": [
        {
          "identity": "john.doe",
          "type": "facebook"
        }
      ]
    }
  }
}

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {
      "experianStatus": "VERIFIED",
      "illionStatus": "AUTOFAIL",
      "overallVerificationStatus": "VERIFIED",
      "sourcesUsed": {
        "AU EMD": "AUTOFAIL",
        "AUBureauHeader": "VERIFIED",
        "Credit History": "AUTOFAIL",
        "Data Co-op": "AUTOFAIL",
        "GDC Asic Person Name": "AUTOFAIL",
        "GDC Tenancy File": "AUTOFAIL",
        "NAD": "AUTOFAIL",
        "PND": "AUTOFAIL",
        "PayrollData": "AUTOFAIL",
        "SuperannuationData": "AUTOFAIL"
      }
    },
    "export": {
      "sku": [
        "greenID_AU_NZ_govID_platformcharge",
        "greenID_AU_AML",
        "greenID_AU_superpayroll",
        "greenID_AU_experian"
      ]
    },
    "outcome": "Pass"
  }
}

Experian credit bureau check

Experian Credit Bureau Check

Value	Description
`VERIFIED`	Verified
`AUTOFAIL`	Autofail
`ERROR`	Error
`NOT_CONTRIBUTING`	Not Contributing

Overall verification result

The overall result will confirm if the verification rule has been met.

Value	Description
`VERIFIED`	Verified
`IN_PROGRESS`	In Progress (not verified)

Experian credit bureau check

Experian Credit Bureau Check

Value	Description
`VERIFIED`	Verified
`AUTOFAIL`	Autofail
`ERROR`	Error
`NOT_CONTRIBUTING`	Not Contributing

Australia: Single match standard sources (with additional sources) (non-AML)

One match on any Australian standard and additional sources for non-AML customers.

Detail	Value
Required inputs	Determined by the registration process
Optional inputs	None

The capabilities include only the overall verification result (VERIFIED, IN_PROGRESS). Default outcomes are the same: Pass / Refer / Error.

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Pass`	Overall verification result is `VERIFIED`	The data source verifies the subject’s identity.
`Refer`	Overall verification result is `IN_PROGRESS`	The verification is still in progress and needs follow-up.
`Error`	Default, when no conditions matched	An unexpected error occurred, so the module couldn’t return a result.

Input payload

The following is a sample payload used to submit identity data to the Data Verification module for processing.

JSON

{
  "resourceId": "your-journey-resourceID@latest",
  "context": {
    "subject": {
      "emails": [
        {
          "email": "john.doe@example.com",
          "type": "personal"
        }
      ],
      "identity": {
        "currentAddress": {
          "administrativeArea": "ACT",
          "building": "42",
          "country": "AU",
          "dependentLocality": "Belconnen",
          "postalCode": "2617",
          "thoroughfare": "Baloney",
          "thoroughfareType": "Street"
        },
        "dateOfBirth": "1980-01-01",
        "firstName": "John",
        "gender": "Male",
        "lastNames": [
          "Doe"
        ],
        "middleNames": [
          "TWOFFFFFFFFFFFFFFFFFFFFFFFFPF"
        ],
        "title": "Mr."
      },
      "phones": [
        {
          "number": "0420000009",
          "type": "mobile"
        }
      ],
      "previousAddress": [],
      "socials": [
        {
          "identity": "john.doe",
          "type": "facebook"
        }
      ]
    }
  }
}

Sample response

The following is a sample response for a successful identity verification.

JSON

{
  "response": {
    "advice": {
      "overallVerificationStatus": "VERIFIED",
      "sourcesUsed": {
        "AU EMD": "AUTOFAIL",
        "Data Co-op": "AUTOFAIL",
        "GDC Asic Person Name": "AUTOFAIL",
        "GDC Tenancy File": "AUTOFAIL",
        "NAD": "AUTOFAIL",
        "PND": "AUTOFAIL",
        "PayrollData": "VERIFIED",
        "SuperannuationData": "AUTOFAIL"
      }
    },
    "export": {
      "sku": [
        "greenID_AU_NZ_govID_platformcharge",
        "greenID_AU_nonAML",
        "greenID_AU_superpayroll"
      ]
    },
    "outcome": "Pass"
  }
}

Overall verification result

The overall result will confirm if the verification rule has been met.

Value	Description
`VERIFIED`	Verified
`IN_PROGRESS`	In Progress (not verified)

Australia: Tenancy

Details of Australian tenants living in rental properties. All applications undertake a 100-point ID assessment to verify their identity.

Detail	Value
Required inputs	Full name, date of birth
Optional inputs	None

Capabilities

The table below lists the capabilities returned by this variant.

Capability	Values	Description
Supplier decision	`match`, `mismatch`, `no result`	The data source’s overall match decision.

Default outcomes

The table below lists the default outcomes for this variant.

Outcome	Condition	Description
`Identity Match`	Supplier decision is `match`	Identity confirmed.
`Identity Mismatch`	Default	The subject could not be verified.
`Error`	—	A system or data source error stopped the check from completing.

Input payload

The following is a sample payload used to submit identity data to the Data Verification module for processing.

Replace your-journey-resourceID@latest with your journey’s resource ID. You can find this in the Journey Builder after publishing your journey.

JSON

{
  "resourceId": "your-journey-resourceID@latest",
  "context": {
    "subject": {
      "uid": "variant-test-user",
      "identity": {
        "firstName": "Full",
        "middleNames": ["Good"],
        "lastNames": ["Match"],
        "dateOfBirth": "2007-03-26",
        "currentAddress": {
          "country": "AUS",
          "administrativeArea": "NSW",
          "postalCode": "2000",
          "locality": "Sydney",
          "thoroughfare": "George Street",
          "premise": "1A"
        },
        "phones": [
          {
            "type": "mobile",
            "number": "+61400000000"
          }
        ]
      },
      "accounts": [
        {
          "type": "Bank Account",
          "accountNumber": "12345678",
          "sortCode": "01-02-03"
        }
      ],
      "documents": [
        {
          "type": "Driving Licence",
          "number": "0123456789",
          "cardNumber": "111"
        }
      ]
    }
  }
}

Sample response

The following is a sample response for a successful identity match.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Identity Match"
  }
}

Input payload

The following is a sample payload used to submit data to the Australia - Tenancy module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "12345678",
          "sortCode": "01-02-03",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "111",
          "number": "NZ111111",
          "type": "Driving Licence"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Full",
        "lastNames": [
          "Match"
        ],
        "middleNames": [
          "Good"
        ],
        "phones": [
          {
            "number": "+447795111111",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`DateOfBirth`	Yes	The subject’s date of birth.

Australia - Visa

Government database of Australian visa holders, maintained by the Department of Home Affairs.

Capabilities

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`alert`	alert
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Alert`	Supplier Decision is `alert`	The data source raises an alert for the subject.
`Identity Match`	Supplier Decision is `match`	The data source confirms the subject’s identity.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Australia - Visa module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "11111999",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "number": "NZ222222",
          "type": "Visa"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "A99 9AA",
          "premise": "999",
          "thoroughfare": "Letsby Avenue"
        },
        "dateOfBirth": "2025-01-01",
        "firstName": "Alert",
        "lastNames": [
          "Alert"
        ],
        "phones": [
          {
            "number": "+447700900123",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`FullName/firstName`	Yes	The subject’s first name.
`FullName/lastNames`	Yes	The subject’s last name or names.
`DateOfBirth`	Yes	The subject’s date of birth.
`AustraliaVisa`	No	The number of the subject’s Australian visa.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Alert"
  }
}

Austria - Citizen source

Identity verification - Name, DOB, address, phone and email address

Capabilities

Generic email match result

Indicates if the email has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Initial matches

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Address line 1 match flag

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and (Date of Birth match result is `match` or Date of Birth match result is `partial match`) and (Overall Address match result is `match` or Overall Address match result is `partial match`)	The first name, last name, date of birth, and address all match or partially match.
`Partial Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and ((Date of Birth match result is `match` or Date of Birth match result is `partial match`) or (Overall Address match result is `match` or Overall Address match result is `partial match`))	The first and last names match or partially match, and either the date of birth or address matches or partially matches.
`Could Not Locate`	First Name match result is `not available` and Last Names match result is `not available`	The data source has no record of the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Austria - Citizen source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	No	The subject’s current residential address.
`DateOfBirth`	Yes	The subject’s date of birth.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`OtherEmails`	No	Any additional email addresses associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Austria Credit Bureau

Capabilities

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Building match result

Indicates if the current address’ building has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Middle names match result

Indicates if the middle names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Premise match result

Indicates if the current address’ premise has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Thoroughfare match result

Indicates if the current address’ thoroughfare has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	First Name match result is `match` and Last Names match result is `match` and Date of Birth match result is not `mismatch` and Overall Address match result is `match`	The first name, last name, and address match. The date of birth doesn’t conflict with the record.
`Partial Identity Match`	First Name match result is `match` and Last Names match result is `match` and (Date of Birth match result is `match` or Overall Address match result is `partial match`)	The first and last names match, and either the date of birth matches or the address partially matches.
`Could Not Locate`	Supplier Decision is `unrecognised value`	The data source returned a decision that the module doesn’t recognise, so the module can’t locate the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Austria Credit Bureau module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`FullName/firstName`	Yes	The subject’s first name.
`FullName/middleNames`	No	Any additional registered names of the subject.
`FullName/lastNames`	Yes	The subject’s last name or names.
`FullName/title`	No	The subject’s title, for example, Mr, Ms, or Dr.
`DateOfBirth`	Yes	The subject’s date of birth.
`CurrentAddress`	Yes	The subject’s current residential address.
`CurrentAddress/lines`	No	The full address as one or more free-form lines, used when structured address components are not available.
`CurrentAddress/addressString`	No	The full address as a single line.
`CurrentAddress/premise`	No	The premise (building name or number) of the current address.
`CurrentAddress/building`	No	The building name or number of the current address.
`CurrentAddress/subBuilding`	No	The sub-building (for example, flat or unit) of the current address.
`CurrentAddress/thoroughfare`	No	The street or thoroughfare of the current address.
`CurrentAddress/dependentThoroughfare`	No	The dependent thoroughfare (a smaller street within the thoroughfare) of the current address.
`CurrentAddress/locality`	No	The locality (town or city) of the current address.
`CurrentAddress/dependentLocality`	No	The dependent locality (a smaller area within the locality) of the current address.
`CurrentAddress/doubleDependentLocality`	No	The double dependent locality (a smaller area within the dependent locality) of the current address.
`CurrentAddress/postalCode`	No	The postal or ZIP code of the current address.
`CurrentAddress/postBox`	No	The post office box of the current address.
`CurrentAddress/country`	No	The country of the current address.
`CurrentAddress/superAdministrativeArea`	No	The super-administrative area (a larger region above the administrative area) of the current address.
`CurrentAddress/administrativeArea`	No	The administrative area (for example, state, province, or county) of the current address.
`CurrentAddress/subAdministrativeArea`	No	The sub-administrative area (a smaller region within the administrative area) of the current address.
`CurrentAddress/organization`	No	The company or organization associated with the current address.
`CurrentAddress/location`	No	The geographic location (coordinates) of the current address.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Austria - Single Source

Capabilities

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`no result`	no result

Count of matches against name and address

Count of mmatches against name and address

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and address match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and address and date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against name and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources with more than one field match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against name, address and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and either address or date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	Supplier Decision is `match`	The data source confirms the subject’s identity.
`Partial Identity Match`	Supplier Decision is `partial match`	The data source partially confirms the subject’s identity.
`Identity Mismatch`	Supplier Decision is `mismatch`	The data source returns a mismatch for the subject’s details.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Could Not Locate`	Default, when no conditions matched	The module can’t find a record for the subject in the data source.

Input payload

The following is a sample payload used to submit data to the Austria - Single Source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Full",
        "lastNames": [
          "Match"
        ],
        "middleNames": [
          "Good"
        ],
        "phones": [
          {
            "number": "+447795111111",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	Yes	The subject’s current residential address.
`DateOfBirth`	No	The subject’s date of birth.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Identity Match"
  }
}

Belgium - Citizen source

Identity verification - Name, DOB, address, phone and email address

Capabilities

Generic email match result

Indicates if the email has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Initial matches

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Address line 1 match flag

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and (Date of Birth match result is `match` or Date of Birth match result is `partial match`) and (Overall Address match result is `match` or Overall Address match result is `partial match`)	The first name, last name, date of birth, and address all match or partially match.
`Partial Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and ((Date of Birth match result is `match` or Date of Birth match result is `partial match`) or (Overall Address match result is `match` or Overall Address match result is `partial match`))	The first and last names match or partially match, and either the date of birth or address matches or partially matches.
`Could Not Locate`	First Name match result is `not available` and Last Names match result is `not available`	The data source has no record of the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Belgium - Citizen source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	No	The subject’s current residential address.
`DateOfBirth`	Yes	The subject’s date of birth.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`OtherEmails`	No	Any additional email addresses associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Belgium Consumer

Capabilities

Generic email match result

Indicates if the email has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Building match result

Indicates if the current address’ building has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Middle names match result

Indicates if the middle names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Premise match result

Indicates if the current address’ premise has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Thoroughfare match result

Indicates if the current address’ thoroughfare has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	First Name match result is `match` and Last Names match result is `match` and Overall Address match result is `match` and Date of Birth match result is not `mismatch`	The first name, last name, and address match. The date of birth doesn’t conflict with the record.
`Partial Identity Match`	First Name match result is `match` and Last Names match result is `match` and (Date of Birth match result is `match` or Overall Address match result is `partial match`)	The first and last names match, and either the date of birth matches or the address partially matches.
`Could Not Locate`	Supplier Decision is `unrecognised value`	The data source returned a decision that the module doesn’t recognise, so the module can’t locate the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Belgium Consumer module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`MobilePhone`	No	The subject’s mobile telephone number.
`WorkPhone`	No	The subject’s work telephone number.
`LandlinePhone`	No	The subject’s landline telephone number.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`FullName`	Yes	The subject’s full name, including given and family names.
`FullName/firstName`	Yes	The subject’s first name.
`FullName/middleNames`	No	Any additional registered names of the subject.
`FullName/lastNames`	Yes	The subject’s last name or names.
`FullName/title`	No	The subject’s title, for example, Mr, Ms, or Dr.
`DateOfBirth`	Yes	The subject’s date of birth.
`CurrentAddress`	No	The subject’s current residential address.
`CurrentAddress/lines`	No	The full address as one or more free-form lines, used when structured address components are not available.
`CurrentAddress/addressString`	No	The full address as a single line.
`CurrentAddress/premise`	No	The premise (building name or number) of the current address.
`CurrentAddress/building`	No	The building name or number of the current address.
`CurrentAddress/subBuilding`	No	The sub-building (for example, flat or unit) of the current address.
`CurrentAddress/thoroughfare`	No	The street or thoroughfare of the current address.
`CurrentAddress/dependentThoroughfare`	No	The dependent thoroughfare (a smaller street within the thoroughfare) of the current address.
`CurrentAddress/locality`	No	The locality (town or city) of the current address.
`CurrentAddress/dependentLocality`	No	The dependent locality (a smaller area within the locality) of the current address.
`CurrentAddress/doubleDependentLocality`	No	The double dependent locality (a smaller area within the dependent locality) of the current address.
`CurrentAddress/postalCode`	No	The postal or ZIP code of the current address.
`CurrentAddress/postBox`	No	The post office box of the current address.
`CurrentAddress/country`	No	The country of the current address.
`CurrentAddress/superAdministrativeArea`	No	The super-administrative area (a larger region above the administrative area) of the current address.
`CurrentAddress/administrativeArea`	No	The administrative area (for example, state, province, or county) of the current address.
`CurrentAddress/subAdministrativeArea`	No	The sub-administrative area (a smaller region within the administrative area) of the current address.
`CurrentAddress/organization`	No	The company or organization associated with the current address.
`CurrentAddress/location`	No	The geographic location (coordinates) of the current address.
`PersonalEmail`	No	The subject’s personal email address.
`WorkEmail`	No	The subject’s work email address.
`OtherEmails`	No	Any additional email addresses associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Belgium Residential

Capabilities

Generic email match result

Indicates if the email has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Building match result

Indicates if the current address’ building has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Middle names match result

Indicates if the middle names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Premise match result

Indicates if the current address’ premise has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Thoroughfare match result

Indicates if the current address’ thoroughfare has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	First Name match result is `match` and Last Names match result is `match` and Overall Address match result is `match` and Date of Birth match result is not `mismatch`	The first name, last name, and address match. The date of birth doesn’t conflict with the record.
`Partial Identity Match`	First Name match result is `match` and Last Names match result is `match` and (Date of Birth match result is `match` or Overall Address match result is `partial match`)	The first and last names match, and either the date of birth matches or the address partially matches.
`Could Not Locate`	Supplier Decision is `unrecognised value`	The data source returned a decision that the module doesn’t recognise, so the module can’t locate the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Belgium Residential module for processing.

JSON

{
  "context": {
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      },
      "uid": "variant-test-user"
    }
  }
}

Field	Required	Description
`MobilePhone`	No	The subject’s mobile telephone number.
`FullName`	Yes	The subject’s full name, including given and family names.
`FullName/firstName`	Yes	The subject’s first name.
`FullName/middleNames`	No	Any additional registered names of the subject.
`FullName/lastNames`	Yes	The subject’s last name or names.
`FullName/title`	No	The subject’s title, for example, Mr, Ms, or Dr.
`DateOfBirth`	No	The subject’s date of birth.
`CurrentAddress`	Yes	The subject’s current residential address.
`CurrentAddress/lines`	No	The full address as one or more free-form lines, used when structured address components are not available.
`CurrentAddress/addressString`	No	The full address as a single line.
`CurrentAddress/premise`	No	The premise (building name or number) of the current address.
`CurrentAddress/building`	No	The building name or number of the current address.
`CurrentAddress/subBuilding`	No	The sub-building (for example, flat or unit) of the current address.
`CurrentAddress/thoroughfare`	No	The street or thoroughfare of the current address.
`CurrentAddress/dependentThoroughfare`	No	The dependent thoroughfare (a smaller street within the thoroughfare) of the current address.
`CurrentAddress/locality`	No	The locality (town or city) of the current address.
`CurrentAddress/dependentLocality`	No	The dependent locality (a smaller area within the locality) of the current address.
`CurrentAddress/doubleDependentLocality`	No	The double dependent locality (a smaller area within the dependent locality) of the current address.
`CurrentAddress/postalCode`	No	The postal or ZIP code of the current address.
`CurrentAddress/postBox`	No	The post office box of the current address.
`CurrentAddress/country`	No	The country of the current address.
`CurrentAddress/superAdministrativeArea`	No	The super-administrative area (a larger region above the administrative area) of the current address.
`CurrentAddress/administrativeArea`	No	The administrative area (for example, state, province, or county) of the current address.
`CurrentAddress/subAdministrativeArea`	No	The sub-administrative area (a smaller region within the administrative area) of the current address.
`CurrentAddress/organization`	No	The company or organization associated with the current address.
`CurrentAddress/location`	No	The geographic location (coordinates) of the current address.
`WorkPhone`	No	The subject’s work telephone number.
`LandlinePhone`	No	The subject’s landline telephone number.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`PersonalEmail`	No	The subject’s personal email address.
`WorkEmail`	No	The subject’s work email address.
`OtherEmails`	No	Any additional email addresses associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Belgium - Single Source v2

Capabilities

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`no result`	no result

Count of matches against name and address

Count of mmatches against name and address

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and address match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and address and date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against name and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources with more than one field match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against name, address and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and either address or date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	Supplier Decision is `match`	The data source confirms the subject’s identity.
`Partial Identity Match`	Supplier Decision is `partial match`	The data source partially confirms the subject’s identity.
`Identity Mismatch`	Supplier Decision is `mismatch`	The data source returns a mismatch for the subject’s details.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Could Not Locate`	Default, when no conditions matched	The module can’t find a record for the subject in the data source.

Input payload

The following is a sample payload used to submit data to the Belgium - Single Source v2 module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Full",
        "lastNames": [
          "Match"
        ],
        "middleNames": [
          "Good"
        ],
        "phones": [
          {
            "number": "+447795111111",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	Yes	The subject’s current residential address.
`DateOfBirth`	No	The subject’s date of birth.
`MobilePhone`	No	The subject’s mobile telephone number.
`WorkPhone`	No	The subject’s work telephone number.
`LandlinePhone`	No	The subject’s landline telephone number.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Identity Match"
  }
}

Belgium Utility

Capabilities

Generic email match result

Indicates if the email has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Building match result

Indicates if the current address’ building has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Middle names match result

Indicates if the middle names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Premise match result

Indicates if the current address’ premise has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Thoroughfare match result

Indicates if the current address’ thoroughfare has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	First Name match result is `match` and Last Names match result is `match` and Overall Address match result is `match` and Date of Birth match result is not `mismatch`	The first name, last name, and address match. The date of birth doesn’t conflict with the record.
`Partial Identity Match`	First Name match result is `match` and Last Names match result is `match` and (Date of Birth match result is `match` or Overall Address match result is `partial match`)	The first and last names match, and either the date of birth matches or the address partially matches.
`Could Not Locate`	Supplier Decision is `unrecognised value`	The data source returned a decision that the module doesn’t recognise, so the module can’t locate the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Belgium Utility module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`MobilePhone`	No	The subject’s mobile telephone number.
`WorkPhone`	No	The subject’s work telephone number.
`LandlinePhone`	No	The subject’s landline telephone number.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`FullName`	Yes	The subject’s full name, including given and family names.
`FullName/firstName`	Yes	The subject’s first name.
`FullName/middleNames`	No	Any additional registered names of the subject.
`FullName/lastNames`	Yes	The subject’s last name or names.
`FullName/title`	No	The subject’s title, for example, Mr, Ms, or Dr.
`DateOfBirth`	Yes	The subject’s date of birth.
`CurrentAddress`	No	The subject’s current residential address.
`CurrentAddress/lines`	No	The full address as one or more free-form lines, used when structured address components are not available.
`CurrentAddress/addressString`	No	The full address as a single line.
`CurrentAddress/premise`	No	The premise (building name or number) of the current address.
`CurrentAddress/building`	No	The building name or number of the current address.
`CurrentAddress/subBuilding`	No	The sub-building (for example, flat or unit) of the current address.
`CurrentAddress/thoroughfare`	No	The street or thoroughfare of the current address.
`CurrentAddress/dependentThoroughfare`	No	The dependent thoroughfare (a smaller street within the thoroughfare) of the current address.
`CurrentAddress/locality`	No	The locality (town or city) of the current address.
`CurrentAddress/dependentLocality`	No	The dependent locality (a smaller area within the locality) of the current address.
`CurrentAddress/doubleDependentLocality`	No	The double dependent locality (a smaller area within the dependent locality) of the current address.
`CurrentAddress/postalCode`	No	The postal or ZIP code of the current address.
`CurrentAddress/postBox`	No	The post office box of the current address.
`CurrentAddress/country`	No	The country of the current address.
`CurrentAddress/superAdministrativeArea`	No	The super-administrative area (a larger region above the administrative area) of the current address.
`CurrentAddress/administrativeArea`	No	The administrative area (for example, state, province, or county) of the current address.
`CurrentAddress/subAdministrativeArea`	No	The sub-administrative area (a smaller region within the administrative area) of the current address.
`CurrentAddress/organization`	No	The company or organization associated with the current address.
`CurrentAddress/location`	No	The geographic location (coordinates) of the current address.
`PersonalEmail`	No	The subject’s personal email address.
`WorkEmail`	No	The subject’s work email address.
`OtherEmails`	No	Any additional email addresses associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Brazil - Citizen source

Identity verification - Name, DOB, address, phone and email address

Capabilities

Generic email match result

Indicates if the email has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Initial matches

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Address line 1 match flag

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and (Date of Birth match result is `match` or Date of Birth match result is `partial match`) and (Overall Address match result is `match` or Overall Address match result is `partial match`)	The first name, last name, date of birth, and address all match or partially match.
`Partial Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and ((Date of Birth match result is `match` or Date of Birth match result is `partial match`) or (Overall Address match result is `match` or Overall Address match result is `partial match`))	The first and last names match or partially match, and either the date of birth or address matches or partially matches.
`Could Not Locate`	First Name match result is `not available` and Last Names match result is `not available`	The data source has no record of the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Brazil - Citizen source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	No	The subject’s current residential address.
`DateOfBirth`	Yes	The subject’s date of birth.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`OtherEmails`	No	Any additional email addresses associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Brazil National ID

Capabilities

CPF match result

CPF match result flag

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Building match result

Indicates if the current address’ building has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Middle names match result

Indicates if the middle names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Premise match result

Indicates if the current address’ premise has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Thoroughfare match result

Indicates if the current address’ thoroughfare has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	First Name match result is `match` and Last Names match result is `match` and Date of Birth match result is not `mismatch` and Overall Address match result is `match` and CPF match result is not `mismatch`	The first name, last name, and address match. The date of birth and CPF number don’t conflict with the record.
`Partial Identity Match`	First Name match result is `match` and Last Names match result is `match` and (Date of Birth match result is `match` or Overall Address match result is `partial match`)	The first and last names match, and either the date of birth matches or the address partially matches.
`Could Not Locate`	Supplier Decision is `unrecognised value`	The data source returned a decision that the module doesn’t recognise, so the module can’t locate the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Brazil National ID module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "12345678",
          "sortCode": "01-02-03",
          "type": "Bank Account"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "idNumbers": [
          {
            "idNumber": "12345678901",
            "type": "CPF Number"
          }
        ],
        "lastNames": [
          "Person"
        ],
        "middleNames": [
          "Missing"
        ],
        "phones": [
          {
            "number": "+447795111111",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`FullName/firstName`	Yes	The subject’s first name.
`FullName/middleNames`	No	Any additional registered names of the subject.
`FullName/lastNames`	Yes	The subject’s last name or names.
`FullName/title`	No	The subject’s title, for example, Mr, Ms, or Dr.
`CurrentAddress`	Yes	The subject’s current residential address.
`CurrentAddress/lines`	No	The full address as one or more free-form lines, used when structured address components are not available.
`CurrentAddress/addressString`	No	The full address as a single line.
`CurrentAddress/premise`	No	The premise (building name or number) of the current address.
`CurrentAddress/building`	No	The building name or number of the current address.
`CurrentAddress/subBuilding`	No	The sub-building (for example, flat or unit) of the current address.
`CurrentAddress/thoroughfare`	No	The street or thoroughfare of the current address.
`CurrentAddress/dependentThoroughfare`	No	The dependent thoroughfare (a smaller street within the thoroughfare) of the current address.
`CurrentAddress/locality`	No	The locality (town or city) of the current address.
`CurrentAddress/dependentLocality`	No	The dependent locality (a smaller area within the locality) of the current address.
`CurrentAddress/doubleDependentLocality`	No	The double dependent locality (a smaller area within the dependent locality) of the current address.
`CurrentAddress/postalCode`	No	The postal or ZIP code of the current address.
`CurrentAddress/postBox`	No	The post office box of the current address.
`CurrentAddress/country`	No	The country of the current address.
`CurrentAddress/superAdministrativeArea`	No	The super-administrative area (a larger region above the administrative area) of the current address.
`CurrentAddress/administrativeArea`	No	The administrative area (for example, state, province, or county) of the current address.
`CurrentAddress/subAdministrativeArea`	No	The sub-administrative area (a smaller region within the administrative area) of the current address.
`CurrentAddress/organization`	No	The company or organization associated with the current address.
`CurrentAddress/location`	No	The geographic location (coordinates) of the current address.
`IdentityCard`	Yes	The number of the subject’s national identity card.
`CPFNumber`	Yes	The subject’s CPF number.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Brazil Residential

Capabilities

CPF match result

CPF Match

Value	Description
`match`	match flag
`mismatch`	mismatch flag
`not available`	not available flag
`unrecognised value`	unrecognised value flag
`no result`	no result flag

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Building match result

Indicates if the current address’ building has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Middle names match result

Indicates if the middle names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Premise match result

Indicates if the current address’ premise has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Thoroughfare match result

Indicates if the current address’ thoroughfare has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Mobile phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	First Name match result is `match` and Last Names match result is `match` and Date of Birth match result is not `mismatch` and Overall Address match result is `match` and CPF match result is not `mismatch`	The first name, last name, and address match. The date of birth and CPF number don’t conflict with the record.
`Partial Identity Match`	First Name match result is `match` and Last Names match result is `match` and (Date of Birth match result is `match` or Overall Address match result is `partial match`)	The first and last names match, and either the date of birth matches or the address partially matches.
`Could Not Locate`	Supplier Decision is `unrecognised value`	The data source returned a decision that the module doesn’t recognise, so the module can’t locate the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Brazil Residential module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "12345678",
          "sortCode": "01-02-03",
          "type": "Bank Account"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "idNumbers": [
          {
            "idNumber": "12345678901",
            "type": "CPF Number"
          }
        ],
        "lastNames": [
          "Person"
        ],
        "middleNames": [
          "Missing"
        ],
        "phones": [
          {
            "number": "+447795111111",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`MobilePhone`	No	The subject’s mobile telephone number.
`FullName`	Yes	The subject’s full name, including given and family names.
`FullName/firstName`	Yes	The subject’s first name.
`FullName/middleNames`	No	Any additional registered names of the subject.
`FullName/lastNames`	Yes	The subject’s last name or names.
`FullName/title`	No	The subject’s title, for example, Mr, Ms, or Dr.
`DateOfBirth`	Yes	The subject’s date of birth.
`CurrentAddress`	Yes	The subject’s current residential address.
`CurrentAddress/lines`	No	The full address as one or more free-form lines, used when structured address components are not available.
`CurrentAddress/addressString`	No	The full address as a single line.
`CurrentAddress/premise`	No	The premise (building name or number) of the current address.
`CurrentAddress/building`	No	The building name or number of the current address.
`CurrentAddress/subBuilding`	No	The sub-building (for example, flat or unit) of the current address.
`CurrentAddress/thoroughfare`	No	The street or thoroughfare of the current address.
`CurrentAddress/dependentThoroughfare`	No	The dependent thoroughfare (a smaller street within the thoroughfare) of the current address.
`CurrentAddress/locality`	No	The locality (town or city) of the current address.
`CurrentAddress/dependentLocality`	No	The dependent locality (a smaller area within the locality) of the current address.
`CurrentAddress/doubleDependentLocality`	No	The double dependent locality (a smaller area within the dependent locality) of the current address.
`CurrentAddress/postalCode`	No	The postal or ZIP code of the current address.
`CurrentAddress/postBox`	No	The post office box of the current address.
`CurrentAddress/country`	No	The country of the current address.
`CurrentAddress/superAdministrativeArea`	No	The super-administrative area (a larger region above the administrative area) of the current address.
`CurrentAddress/administrativeArea`	No	The administrative area (for example, state, province, or county) of the current address.
`CurrentAddress/subAdministrativeArea`	No	The sub-administrative area (a smaller region within the administrative area) of the current address.
`CurrentAddress/organization`	No	The company or organization associated with the current address.
`CurrentAddress/location`	No	The geographic location (coordinates) of the current address.
`CPFNumber`	Yes	The subject’s CPF number.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Brazil: Single match with CPF

Performs a single-source identity verification check for Brazilian subjects with a required CPF (Cadastro de Pessoas Fisicas) number, the Brazilian individual taxpayer registration number issued by the Federal Revenue Service.

Detail	Value
Required inputs	Full name, CPF number
Optional inputs	Gender, date of birth, current address, mobile phone, landline phone, identity card

The capabilities are the same as Argentina: Single match.

Default outcomes

The table below lists the default outcomes for this variant.

Outcome	Condition	Description
`ALERT`	Is under 18 is `true`	The subject is under 18.
`Match`	Name + DOB + Address ≥ 1 or ID + Name + Address ≥ 1 or ID + Name + DOB ≥ 1 or ID + Name + DOB + Address ≥ 1	Full match. At least one source confirmed a strong element combination.
`Partial Match`	Name + Address ≥ 1 or Name + DOB ≥ 1	Some elements matched, but not a full combination.
`No Match`	Name + Address < 1	No match.
`Error`	Default	An unexpected error occurred.

Input payload

The following is a sample payload used to submit identity data to the Data Verification module for processing.

JSON

{
  "resourceId": "your-journey-resourceID@latest",
  "context": {
    "subject": {
      "identity": {
        "currentAddress": {
          "administrativeArea": "RJ",
          "building": "792",
          "country": "BRA",
          "locality": "Rio de Janeiro",
          "postalCode": "21760620",
          "thoroughfare": "Travessa Helena"
        },
        "dateOfBirth": "2099-02-01",
        "firstName": "Adalberto",
        "idNumbers": [
          {
            "country": "BRA",
            "idNumber": "87565779318",
            "type": "cpfNumber"
          }
        ],
        "lastNames": [
          "Costa Silva"
        ],
        "phones": [
          {
            "number": "12025550123",
            "type": "Mobile"
          },
          {
            "number": "2025550123",
            "type": "Landline"
          }
        ]
      },
      "uid": "Test Case 0390-016"
    }
  }
}

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {
      "customDecision": null,
      "gbgScore": 114,
      "idName": 0,
      "idNameAddress": 0,
      "idNameAddressDob": 0,
      "idNameDob": 0,
      "isUnder18": true,
      "nameAddress": 0,
      "nameDob": 0,
      "nameDobAddress": 0,
      "sources": 0
    },
    "outcome": "ALERT"
  }
}

Number of matching sources

Number of sources with any match type

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + address matches

Number of sources where Name and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + DOB matches

Number of sources where Name and Date of Birth matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + DOB + address matches

Number of sources where Name, Date of Birth, and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + name + address matches

Number of sources where ID number, Name, and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + name + DOB matches

Number of sources where ID number, Name, and Date of Birth matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + name + DOB + address matches

Number of sources where ID number, Name, Date of Birth, and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Is under 18

Indicates if the user is under 18 years old

Detail	Description
Type	Boolean
Default	`isFalse`

GBG score

GBG score for identity verification

Detail	Description
Type	Integer
Range	0–1000
Default	`0`

Brazil: Single match without CPF

Performs a single-source identity verification check for Brazilian subjects without requiring a CPF number. It is suited for situations where a CPF is not available or required.

Detail	Value
Required inputs	Full name
Optional inputs	Gender, date of birth, current address, mobile phone, CPF number, identity card, landline phone

The capabilities are the same as Argentina: Single match.

Default outcomes

The table below lists the default outcomes for this variant.

Outcome	Condition	Description
`ALERT`	Is under 18 is `true`	The subject is under 18.
`Match`	Name + DOB + Address ≥ 1	Full match on name, DOB, and address.
`Partial Match`	Name + Address ≥ 1 or Name + DOB ≥ 1	Partial match.
`No Match`	Name + Address < 1	No match.
`Error`	Default	An unexpected error occurred.

Input payload

The following is a sample payload used to submit identity data to the Data Verification module for processing.

JSON

{
  "resourceId": "your-journey-resourceID@latest",
  "context": {
    "subject": {
      "identity": {
        "dateOfBirth": "2024-11-03",
        "firstName": "Robson",
        "lastNames": [
          "Jose Ferreira"
        ]
      }
    }
  }
}

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {
      "customDecision": null,
      "gbgScore": 0,
      "idName": 0,
      "idNameAddress": 0,
      "idNameAddressDob": 0,
      "idNameDob": 0,
      "isUnder18": true,
      "nameAddress": 0,
      "nameDob": 0,
      "nameDobAddress": 0,
      "sources": 0
    },
    "outcome": "ALERT"
  }
}

Number of matching sources

Number of sources with any match type

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + address matches

Number of sources where Name and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + DOB matches

Number of sources where Name and Date of Birth matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + DOB + address matches

Number of sources where Name, Date of Birth, and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Is under 18

Indicates if the user is under 18 years old

Detail	Description
Type	Boolean
Default	`isFalse`

GBG score

GBG score for identity verification

Detail	Description
Type	Integer
Range	0–1000
Default	`0`

Brazil - Single Source

Capabilities

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`no result`	no result

Count of matches against name and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against name, address and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and either address or date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document and name

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document, name, address and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against name and address

Count of mmatches against name and address

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document, name and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and address match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and address and date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources with more than one field match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document, name and address

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	Supplier Decision is `match`	The data source confirms the subject’s identity.
`Partial Identity Match`	Supplier Decision is `partial match`	The data source partially confirms the subject’s identity.
`Identity Mismatch`	Supplier Decision is `mismatch`	The data source returns a mismatch for the subject’s details.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Could Not Locate`	Default, when no conditions matched	The module can’t find a record for the subject in the data source.

Input payload

The following is a sample payload used to submit data to the Brazil - Single Source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "12345678",
          "sortCode": "01-02-03",
          "type": "Bank Account"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Full",
        "idNumbers": [
          {
            "idNumber": "123.456.789-09",
            "type": "identityCard"
          }
        ],
        "lastNames": [
          "Match"
        ],
        "middleNames": [
          "Good"
        ],
        "phones": [
          {
            "number": "+447795111111",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	No	The subject’s current residential address.
`DateOfBirth`	No	The subject’s date of birth.
`MobilePhone`	No	The subject’s mobile telephone number.
`WorkPhone`	No	The subject’s work telephone number.
`LandlinePhone`	No	The subject’s landline telephone number.
`IdentityCard`	No	The number of the subject’s national identity card.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Identity Match"
  }
}

Brazil Tax Registration

Capabilities

CPF number match result

CPF Number match result

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Building match result

Indicates if the current address’ building has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Middle names match result

Indicates if the middle names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Premise match result

Indicates if the current address’ premise has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Thoroughfare match result

Indicates if the current address’ thoroughfare has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	First Name match result is `match` and Last Names match result is `match` and Date of Birth match result is not `mismatch` and Overall Address match result is `match` and CPF Number match result is not `mismatch`	The first name, last name, and address match. The date of birth and CPF number don’t conflict with the record.
`Partial Identity Match`	First Name match result is `match` and Last Names match result is `match` and (Date of Birth match result is `match` or Overall Address match result is `partial match`)	The first and last names match, and either the date of birth matches or the address partially matches.
`Could Not Locate`	Supplier Decision is `unrecognised value`	The data source returned a decision that the module doesn’t recognise, so the module can’t locate the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Brazil Tax Registration module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "12345678",
          "sortCode": "01-02-03",
          "type": "Bank Account"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "idNumbers": [
          {
            "idNumber": "12345678901",
            "type": "CPF Number"
          }
        ],
        "lastNames": [
          "Person"
        ],
        "middleNames": [
          "Missing"
        ],
        "phones": [
          {
            "number": "+447795111111",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`FullName/firstName`	Yes	The subject’s first name.
`FullName/middleNames`	No	Any additional registered names of the subject.
`FullName/lastNames`	Yes	The subject’s last name or names.
`FullName/title`	No	The subject’s title, for example, Mr, Ms, or Dr.
`CurrentAddress`	Yes	The subject’s current residential address.
`CurrentAddress/lines`	No	The full address as one or more free-form lines, used when structured address components are not available.
`CurrentAddress/addressString`	No	The full address as a single line.
`CurrentAddress/premise`	No	The premise (building name or number) of the current address.
`CurrentAddress/building`	No	The building name or number of the current address.
`CurrentAddress/subBuilding`	No	The sub-building (for example, flat or unit) of the current address.
`CurrentAddress/thoroughfare`	No	The street or thoroughfare of the current address.
`CurrentAddress/dependentThoroughfare`	No	The dependent thoroughfare (a smaller street within the thoroughfare) of the current address.
`CurrentAddress/locality`	No	The locality (town or city) of the current address.
`CurrentAddress/dependentLocality`	No	The dependent locality (a smaller area within the locality) of the current address.
`CurrentAddress/doubleDependentLocality`	No	The double dependent locality (a smaller area within the dependent locality) of the current address.
`CurrentAddress/postalCode`	No	The postal or ZIP code of the current address.
`CurrentAddress/postBox`	No	The post office box of the current address.
`CurrentAddress/country`	No	The country of the current address.
`CurrentAddress/superAdministrativeArea`	No	The super-administrative area (a larger region above the administrative area) of the current address.
`CurrentAddress/administrativeArea`	No	The administrative area (for example, state, province, or county) of the current address.
`CurrentAddress/subAdministrativeArea`	No	The sub-administrative area (a smaller region within the administrative area) of the current address.
`CurrentAddress/organization`	No	The company or organization associated with the current address.
`CurrentAddress/location`	No	The geographic location (coordinates) of the current address.
`IdentityCard`	Yes	The number of the subject’s national identity card.
`CPFNumber`	Yes	The subject’s CPF number.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Bulgaria - Citizen source

Identity verification - Name, DOB, address, phone and email address

Capabilities

Generic email match result

Indicates if the email has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Initial matches

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Address line 1 match flag

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and (Date of Birth match result is `match` or Date of Birth match result is `partial match`) and (Overall Address match result is `match` or Overall Address match result is `partial match`)	The first name, last name, date of birth, and address all match or partially match.
`Partial Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and ((Date of Birth match result is `match` or Date of Birth match result is `partial match`) or (Overall Address match result is `match` or Overall Address match result is `partial match`))	The first and last names match or partially match, and either the date of birth or address matches or partially matches.
`Could Not Locate`	First Name match result is `not available` and Last Names match result is `not available`	The data source has no record of the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the **Bulgaria - Citizen source ** module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	No	The subject’s current residential address.
`DateOfBirth`	Yes	The subject’s date of birth.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`OtherEmails`	No	Any additional email addresses associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Canada - Citizen source

Identity verification - Name, DOB, address, phone and email address

Capabilities

Generic email match result

Indicates if the email has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Initial matches

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Address line 1 match flag

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and (Date of Birth match result is `match` or Date of Birth match result is `partial match`) and (Overall Address match result is `match` or Overall Address match result is `partial match`)	The first name, last name, date of birth, and address all match or partially match.
`Partial Identity Match`	(First Name match result is `match` or First Name match result is `partial match` or Address Line 1 Match Flag is `match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and ((Date of Birth match result is `match` or Date of Birth match result is `partial match`) or (Overall Address match result is `match` or Overall Address match result is `partial match`))	The first name or address line 1 matches. The last name and either the date of birth or address also match or partially match.
`Could Not Locate`	First Name match result is `not available` and Last Names match result is `not available`	The data source has no record of the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Canada - Citizen source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	No	The subject’s current residential address.
`DateOfBirth`	Yes	The subject’s date of birth.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`OtherEmails`	No	Any additional email addresses associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Canada - Credit Bureau - FINTRAC 1

Canadian FINTRAC source

Capabilities

Tradeline two postal code

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Tradeline two first name

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Tradeline one middle names

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Tradeline two name and DOB match

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Supplied DOB below age threshold

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Deceased flag

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Tradeline one locality

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Two or more distinct tradelines found

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Tradeline one administrative area

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Tradeline one premise

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Premise match result

Indicates if the current address’ premise has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Age of credit file three or more years old

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Tradeline two last names

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Tradeline one name and address match

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Tradeline two age of credit file more than six months

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Tradeline two age of two or more tradelines over six months

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Tradeline one age of two or more tradelines over six months

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Tradeline one name and DOB match

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`no result`	no result

Tradeline one first name

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Tradeline one last names

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Tradeline two administrative area

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Warning flag

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Dual process match

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Tradeline two middle names

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Middle names match result

Indicates if the middle names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

More than one distinct source

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Tradeline one postal code

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Tradeline one age of credit file more than six months

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Tradeline two name and address match

Value	Description
`Y`	Y
`N`	N
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Tradeline two locality

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Tradeline two premise

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Tradeline two thoroughfare

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Single tradeline match

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Credit file match

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Thoroughfare match result

Indicates if the current address’ thoroughfare has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Credit file from canada

Value	Description
`Y`	Y
`no result`	no result

Tradeline one thoroughfare

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Alert`	Supplied DOB Below Age Threshold is `Y` or Deceased Flag is `Y` or Warning Flag is `Y`	The subject is below the age threshold, or the record has a deceased or warning flag.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Client Credit File Pass Decision`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and (Date of Birth match result is `match` or Date of Birth match result is `partial match`) and (Premise match result is `match` and Thoroughfare match result is `match` and Locality match result is `match` and Postal Code match result is `match` and Administrative Area match result is `match` and Age of Credit File Three or More Years Old is `Y` and Credit File From Canada is `Y` and More Than One Distinct Source is `Y`)	The name, date of birth, and full address match a Canadian credit file that’s at least 3 years old and has multiple sources.
`Client Dual Process Pass Decision`	(Tradeline One Name and Address Match is `Y` and Tradeline Two Name and DOB Match is `Y` and Two or More Distinct Tradelines Found is `Y` and Tradeline One Age of Two or More Tradelines Over Six Months is `Y` and Tradeline One Age of Credit File More Than Six Months is `Y`) or (Tradeline Two Name and Address Match is `Y` and Tradeline One Name and DOB Match is `Y` and Two or More Distinct Tradelines Found is `Y` and Tradeline Two Age of Two or More Tradelines Over Six Months is `Y` and Tradeline Two Age of Credit File More Than Six Months is `Y`)	Two distinct tradelines over 6 months old confirm the name with the address and date of birth. The credit file is over 6 months old.
`Single Tradeline N&A Match (Combined Decision)`	Tradeline One Name and Address Match is `Y` and Tradeline One Age of Credit File More Than Six Months is `Y`	One tradeline matches the name and address, and the credit file is over 6 months old.
`Single Tradeline N&D Match (Combined Decision)`	Tradeline One Name and DOB Match is `Y` and Tradeline One Age of Credit File More Than Six Months is `Y`	One tradeline matches the name and date of birth, and the credit file is over 6 months old.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Canada - Credit Bureau - FINTRAC 1 module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "11111999",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "999",
          "number": "NZ999999",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "A99 9AA",
          "premise": "999",
          "thoroughfare": "Letsby Avenue"
        },
        "dateOfBirth": "2025-01-01",
        "firstName": "Alert",
        "lastNames": [
          "Alert"
        ],
        "phones": [
          {
            "number": "+447700900123",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	Yes	The subject’s current residential address.
`DateOfBirth`	Yes	The subject’s date of birth.
`SocialInsuranceNumber`	No	The subject’s Social Insurance Number.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Alert"
  }
}

Canada - Credit Bureau - FINTRAC 2

Canadian FINTRAC source

Capabilities

Tradeline two administrative area

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Credit file name match

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Age of two or more tradelines over six months

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Tradeline one last names

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Tradeline two name and address match

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Tradeline one name and DOB match

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Tradeline two thoroughfare

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Tradeline one administrative area

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Credit freeze

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Tradeline one name and address match

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Tradeline two middle names

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Tradeline two name and DOB match

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Dual process match

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Age of credit file more than six months

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`no result`	no result
`unrecognised value`	unrecognised value

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`no result`	no result
`unrecognised value`	unrecognised value

Tradeline two last names

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Tradeline two premise

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Tradeline two sub building

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`no result`	no result
`unrecognised value`	unrecognised value

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`no result`	no result
`unrecognised value`	unrecognised value

Tradeline two first name

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Credit file match

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Thoroughfare match result

Indicates if the current address’ thoroughfare has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`no result`	no result
`unrecognised value`	unrecognised value

Credit file from canada

Value	Description
`Y`	Y
`no result`	no result

Fraud flag

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Tradeline one date of birth

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Tradeline one thoroughfare

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`no result`	no result
`unrecognised value`	unrecognised value

Sub building match result

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Tradeline one premise

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Tradeline two date of birth

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Two or more distinct tradelines found

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Premise match result

Indicates if the current address’ premise has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`no result`	no result
`unrecognised value`	unrecognised value

Age of credit file three or more years old

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Tradeline one middle names

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`no result`	no result
`unrecognised value`	unrecognised value

Tradeline one postal code

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Middle names match result

Indicates if the middle names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`no result`	no result
`unrecognised value`	unrecognised value

Tradeline one sub building

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

More than one distinct source

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Indicates if the document has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`partial match`	partial match
`no result`	no result

Tradeline two locality

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Tradeline one locality

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Tradeline two postal code

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Supplied DOB below age threshold

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Single tradeline match

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Credit file address match

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Tradeline one first name

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Alert`	Supplied DOB Below Age Threshold is `Y` or Credit Freeze is `Y` or Fraud Flag is `Y`	The subject is below the age threshold, or the record has a credit freeze or fraud flag.
`Client Credit File Pass Decision`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and (More Than One Distinct Source is `Y` and Age of Credit File Three or More Years Old is `Y` and Credit File From Canada is `Y` and Date of Birth match result is `match` and Premise match result is `match` and Thoroughfare match result is `match` and Postal Code match result is `match` and Locality match result is `match` and Administrative Area match result is `match`)	The name, date of birth, and full address match a Canadian credit file that’s at least 3 years old and has multiple sources.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Client Dual Process Pass Decision`	(Tradeline One Name and Address Match is `Y` and Tradeline Two Name and DOB Match is `Y` and Two or More Distinct Tradelines Found is `Y` and Age of Two or More Tradelines Over Six Months is `Y` and Age of Credit File More Than Six Months is `Y`) or (Tradeline Two Name and Address Match is `Y` and Tradeline One Name and DOB Match is `Y` and Two or More Distinct Tradelines Found is `Y` and Age of Two or More Tradelines Over Six Months is `Y` and Age of Credit File More Than Six Months is `Y`)	Two distinct tradelines over 6 months old confirm the name with the address and date of birth. The credit file is over 6 months old.
`Single Tradeline N&A Match (Combined Decision)`	Tradeline One Name and Address Match is `Y` and Age of Credit File More Than Six Months is `Y`	One tradeline matches the name and address, and the credit file is over 6 months old.
`Single Tradeline N&D Match (Combined Decision)`	Tradeline One Name and DOB Match is `Y` and Age of Credit File More Than Six Months is `Y`	One tradeline matches the name and date of birth, and the credit file is over 6 months old.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Canada - Credit Bureau - FINTRAC 2 module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "11111999",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "999",
          "number": "NZ999999",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "A99 9AA",
          "premise": "999",
          "thoroughfare": "Letsby Avenue"
        },
        "dateOfBirth": "2025-01-01",
        "firstName": "Alert",
        "lastNames": [
          "Alert"
        ],
        "phones": [
          {
            "number": "+447700900123",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	Yes	The subject’s current residential address.
`DateOfBirth`	Yes	The subject’s date of birth.
`SocialInsuranceNumber`	No	The subject’s Social Insurance Number.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Alert"
  }
}

Canada - Credit Bureau - non FINTRAC 1

Canadian non FINTRAC source

Capabilities

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`no result`	no result

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`no result`	no result

Middle names match result

Indicates if the middle names matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`no result`	no result

Fraud deceased

Value	Description
`Y`	Y
`N`	N
`no result`	no result
`not available`	not available

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`no result`	no result

ID card number match result

Indicates if the document has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`no result`	no result

Fraud identity victim

Value	Description
`Y`	Y
`N`	N
`no result`	no result
`not available`	not available

Credit file history GT6

Value	Description
`Y`	Y
`N`	N
`no result`	no result
`not available`	not available

Credit file no hit

Value	Description
`Y`	Y
`N`	N
`no result`	no result
`not available`	not available

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`no result`	no result

Overall fraud risk

Value	Description
`low`	low
`medium`	medium
`high`	high
`not available`	not available
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`no result`	no result

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`no result`	no result

Known fraud flagged

Value	Description
`Y`	Y
`N`	N
`no result`	no result
`not available`	not available

Credit file trades open GT2

Value	Description
`Y`	Y
`N`	N
`no result`	no result
`not available`	not available

Credit file history LT6

Value	Description
`Y`	Y
`N`	N
`no result`	no result
`not available`	not available

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Match`	First Name match result is `match` and Last Names match result is `match` and Date of Birth match result is `match` and Overall Address match result is `match`	The first name, last name, date of birth, and address all match.
`Partial Identity Match`	First Name match result is `match` and Last Names match result is `match` and (Date of Birth match result is `match` or Overall Address match result is `match`)	The first and last names match, and either the date of birth or address matches.
`Could Not Locate`	First Name match result is `not available` and Last Names match result is `not available`	The data source has no record of the subject.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Canada - Credit Bureau - non FINTRAC 1 module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "number": "719029506",
          "type": "ID Card"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	Yes	The subject’s current residential address.
`DateOfBirth`	Yes	The subject’s date of birth.
`IdentityCard`	No	The number of the subject’s national identity card.
`SocialInsuranceNumber`	No	The subject’s Social Insurance Number.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Canada - Credit Bureau - non FINTRAC 2

Canadian non FINTRAC source

Capabilities

data.responses[].customAttributes.matchDetail.fraudFlag

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`no result`	no result
`partial match`	partial match

Middle names match result

Indicates if the middle names matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`no result`	no result
`partial match`	partial match

Sub building match result

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`no result`	no result
`partial match`	partial match

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`no result`	no result
`partial match`	partial match

Indicates if the document has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

data.responses[].customAttributes.matchDetail.bureauHit

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`no result`	no result

data.responses[].customAttributes.matchDetail.creditFreeze

Value	Description
`Y`	Y
`N`	N
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`no result`	no result
`partial match`	partial match

Premise match result

Indicates if the current address’ premise has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`no result`	no result

Thoroughfare match result

Indicates if the current address’ thoroughfare has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`no result`	no result
`partial match`	partial match

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`no result`	no result
`partial match`	partial match

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	Last Names match result is `match` and First Name match result is `match` and Date of Birth match result is `match` and Overall Address match result is `match`	The first name, last name, date of birth, and address all match.
`Partial Identity Match`	(First Name match result is `match` and Last Names match result is `match` and Date of Birth match result is `match`) or (Last Names match result is `match` and First Name match result is `match` and Overall Address match result is `match`) or ((First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and Date of Birth match result is `match` and Overall Address match result is `match`)	The first and last names match with the date of birth or address. Alternatively, the names partially match and both the date of birth and address match.
`Could Not Locate`	First Name match result is `not available` and Last Names match result is `not available`	The data source has no record of the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Canada - Credit Bureau - non FINTRAC 2 module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "documents": [
        {
          "cardNumber": "111",
          "number": "123456789",
          "type": "Social Insurance"
        }
      ],
      "identity": {
        "currentAddress": {
          "administrativeArea": "QA",
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	Yes	The subject’s current residential address.
`DateOfBirth`	Yes	The subject’s date of birth.
`SocialInsuranceNumber`	No	The subject’s Social Insurance Number.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Canada: Non-Fintrac

Performs a standard identity verification check for Canadian subjects without FINTRAC-specific compliance requirements. It uses the source-count capability structure rather than field-level match flags, and does not include the under-18 flag.

Detail	Value
Required inputs	Full name, current address
Optional inputs	Date of birth, Social Insurance Number (SIN), landline phone

The capabilities are the same as Argentina: Single match, excluding the Is under 18 flag.

Default outcomes

The table below lists the default outcomes for this variant.

Outcome	Condition	Description
`Match`	Name + DOB + Address ≥ 1	Full match.
`Partial Match`	Name + Address ≥ 1 or Name + DOB ≥ 1	Partial match.
`No Match`	Name + Address < 1	No match.
`Error`	Default	An unexpected error occurred.

Input payload

The following is a sample payload used to submit identity data to the Data Verification module for processing.

JSON

{
  "resourceId": "your-journey-resourceID@latest",
  "context": {
    "subject": {
      "identity": {
        "currentAddress": {
          "country": "CAN",
          "postalCode": "E4L3V1",
          "locality": "Sackville",
          "thoroughfare": "Crescent St",
          "building": "21",
          "administrativeArea": "NB"
        },
        "dateOfBirth": "2001-03-27",
        "firstName": "Lino",
        "lastNames": ["Nesbitt"]
      }
    }
  }
}

Sample response

The following is a sample response for a successful identity match.

JSON

{
  "response": {
    "advice": {
      "customDecision": null,
      "gbgScore": 500,
      "idName": 0,
      "idNameAddress": 0,
      "idNameAddressDob": 0,
      "idNameDob": 0,
      "isUnder18": false,
      "nameAddress": 1,
      "nameDob": 1,
      "nameDobAddress": 1,
      "sources": 1
    },
    "outcome": "Match"
  }
}

For a full explanation of match flag values, see match flags in the glossary.

Number of matching sources

Number of sources with any match type

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + address matches

Number of sources where Name and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + DOB matches

Number of sources where Name and Date of Birth matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + DOB + address matches

Number of sources where Name, Date of Birth, and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + name + address matches

Number of sources where ID number, Name, and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + name + DOB matches

Number of sources where ID number, Name, and Date of Birth matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + name + DOB + address matches

Number of sources where ID number, Name, Date of Birth, and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

GBG score

GBG score for identity verification

Detail	Description
Type	Integer
Range	0–1000
Default	`0`

Chile: Single match

Performs a single-source identity verification check for Chilean subjects using their identity card number (Cedula de Identidad / RUN).

Detail	Value
Required inputs	Identity card number
Optional inputs	Full name, date of birth, current address

The capabilities are the same as Argentina: Single match.

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`ALERT`	Is Under 18 is `true`	The subject is under 18.
`Match`	Name + DOB + Address Matches >= `1` or ID + Name + Address Matches >= `1` or ID + Name + DOB Matches >= `1` or ID + Name + DOB + Address Matches >= `1`	At least one source matches the name with two or more of the date of birth, address, and ID number.
`Partial Match`	Name + Address Matches >= `1` or Name + DOB Matches >= `1`	At least one source matches the subject’s name with either the address or date of birth.
`No Match`	Name + Address Matches < `1`	No source matches the subject’s name and address.
`Error`	Default, when no conditions matched	An unexpected error occurred, so the module couldn’t return a result.

Input payload

The following is a sample payload used to submit identity data to the Data Verification module for processing.

JSON

{
  "resourceId": "your-journey-resourceID@latest",
  "context": {
    "subject": {
      "identity": {
        "currentAddress": {
          "building": "123",
          "country": "CHL",
          "locality": "Santiago",
          "thoroughfare": "ABC Street"
        },
        "dateOfBirth": "2024-12-24",
        "firstName": "GASPAR",
        "idNumbers": [
          {
            "country": "CHL",
            "idNumber": "220067849",
            "type": "identityCard"
          }
        ],
        "lastNames": [
          "SOTO"
        ]
      }
    }
  }
}

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {
      "customDecision": null,
      "gbgScore": 0,
      "idName": 0,
      "idNameAddress": 0,
      "idNameAddressDob": 0,
      "idNameDob": 0,
      "isUnder18": true,
      "nameAddress": 0,
      "nameDob": 0,
      "nameDobAddress": 0,
      "sources": 0
    },
    "outcome": "ALERT"
  }
}

Number of matching sources

Number of sources with any match type

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + address matches

Number of sources where Name and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + DOB matches

Number of sources where Name and Date of Birth matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + DOB + address matches

Number of sources where Name, Date of Birth, and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + name + address matches

Number of sources where ID number, Name, and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + name + DOB matches

Number of sources where ID number, Name, and Date of Birth matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + name + DOB + address matches

Number of sources where ID number, Name, Date of Birth, and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Is under 18

Indicates if the user is under 18 years old

Detail	Description
Type	Boolean
Default	`isFalse`

GBG score

GBG score for identity verification

Detail	Description
Type	Integer
Range	0–1000
Default	`0`

Chile - Single Source

Capabilities

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`no result`	no result

Count of matches against name and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against name, address and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and either address or date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document and name

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document, name, address and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against name and address

Count of mmatches against name and address

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document, name and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and address match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and address and date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources with more than one field match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document, name and address

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	Supplier Decision is `match`	The data source confirms the subject’s identity.
`Partial Identity Match`	Supplier Decision is `partial match`	The data source partially confirms the subject’s identity.
`Identity Mismatch`	Supplier Decision is `mismatch`	The data source returns a mismatch for the subject’s details.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Could Not Locate`	Default, when no conditions matched	The module can’t find a record for the subject in the data source.

Input payload

The following is a sample payload used to submit data to the Chile - Single Source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "12345678",
          "sortCode": "01-02-03",
          "type": "Bank Account"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Full",
        "idNumbers": [
          {
            "idNumber": "123456785",
            "type": "identityCard"
          }
        ],
        "lastNames": [
          "Match"
        ],
        "middleNames": [
          "Good"
        ],
        "phones": [
          {
            "number": "+447795111111",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	No	The subject’s current residential address.
`DateOfBirth`	Yes	The subject’s date of birth.
`IdentityCard`	Yes	The number of the subject’s national identity card.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Identity Match"
  }
}

China - National ID

Capabilities

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Middle names match result

Indicates if the middle names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

ID card number match result

Indicates if the document has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	First Name match result is `match` and Last Names match result is `match` and Date of Birth match result is `match` and ID Card number match result is `match`	The first name, last name, date of birth, and ID card number all match.
`Partial Identity Match`	First Name match result is `match` and Last Names match result is `match` and (Date of Birth match result is `match` or ID Card number match result is `match`)	The first and last names match, and either the date of birth or ID card number matches.
`Identity Mismatch`	First Name match result is not `match` or Last Names match result is not `match`	The first name or last name doesn’t fully match.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Could Not Locate`	Default, when no conditions matched	The module can’t find a record for the subject in the data source.

Input payload

The following is a sample payload used to submit data to the China - National ID module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "12345678",
          "sortCode": "01-02-03",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "111",
          "number": "11010119900307234X",
          "type": "ID Card"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Full",
        "lastNames": [
          "Match"
        ],
        "middleNames": [
          "Good"
        ],
        "phones": [
          {
            "number": "+447795111111",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`FullName/firstName`	Yes	The subject’s first name.
`FullName/middleNames`	No	Any additional registered names of the subject.
`FullName/lastNames`	Yes	The subject’s last name or names.
`FullName/title`	No	The subject’s title, for example, Mr, Ms, or Dr.
`DateOfBirth`	Yes	The subject’s date of birth.
`CurrentAddress`	No	The subject’s current residential address.
`CurrentAddress/lines`	No	The full address as one or more free-form lines, used when structured address components are not available.
`CurrentAddress/addressString`	No	The full address as a single line.
`CurrentAddress/premise`	No	The premise (building name or number) of the current address.
`CurrentAddress/building`	No	The building name or number of the current address.
`CurrentAddress/subBuilding`	No	The sub-building (for example, flat or unit) of the current address.
`CurrentAddress/thoroughfare`	No	The street or thoroughfare of the current address.
`CurrentAddress/dependentThoroughfare`	No	The dependent thoroughfare (a smaller street within the thoroughfare) of the current address.
`CurrentAddress/locality`	No	The locality (town or city) of the current address.
`CurrentAddress/dependentLocality`	No	The dependent locality (a smaller area within the locality) of the current address.
`CurrentAddress/doubleDependentLocality`	No	The double dependent locality (a smaller area within the dependent locality) of the current address.
`CurrentAddress/postalCode`	No	The postal or ZIP code of the current address.
`CurrentAddress/postBox`	No	The post office box of the current address.
`CurrentAddress/country`	No	The country of the current address.
`CurrentAddress/superAdministrativeArea`	No	The super-administrative area (a larger region above the administrative area) of the current address.
`CurrentAddress/administrativeArea`	No	The administrative area (for example, state, province, or county) of the current address.
`CurrentAddress/subAdministrativeArea`	No	The sub-administrative area (a smaller region within the administrative area) of the current address.
`CurrentAddress/organization`	No	The company or organization associated with the current address.
`CurrentAddress/location`	No	The geographic location (coordinates) of the current address.
`IdNumbers`	Yes	The subject’s identity document numbers, each with the type of document it belongs to.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Identity Match"
  }
}

Colombia - Citizen source

Identity verification - Name, DOB, address, phone and email address

Capabilities

Generic email match result

Indicates if the email has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Initial matches

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Address line 1 match flag

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and (Date of Birth match result is `match` or Date of Birth match result is `partial match`) and (Overall Address match result is `match` or Overall Address match result is `partial match`)	The first name, last name, date of birth, and address all match or partially match.
`Partial Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and ((Date of Birth match result is `match` or Date of Birth match result is `partial match`) or (Overall Address match result is `match` or Overall Address match result is `partial match`))	The first and last names match or partially match, and either the date of birth or address matches or partially matches.
`Could Not Locate`	First Name match result is `not available` and Last Names match result is `not available`	The data source has no record of the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Colombia - Citizen source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	No	The subject’s current residential address.
`DateOfBirth`	Yes	The subject’s date of birth.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`OtherEmails`	No	Any additional email addresses associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Colombia: Single match

Performs a single-source identity verification check for Colombian subjects using their identity card number (Cedula de Ciudadania).

Detail	Value
Required inputs	Full name, current address, identity card number
Optional inputs	Date of birth

The capabilities are the same as Argentina: Single match.

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`ALERT`	Is Under 18 is `true`	The subject is under 18.
`Match`	Name + DOB + Address Matches >= `1` or ID + Name + Address Matches >= `1` or ID + Name + DOB Matches >= `1` or ID + Name + DOB + Address Matches >= `1`	At least one source matches the name with two or more of the date of birth, address, and ID number.
`Partial Match`	Name + Address Matches >= `1` or Name + DOB Matches >= `1`	At least one source matches the subject’s name with either the address or date of birth.
`No Match`	Name + Address Matches < `1`	No source matches the subject’s name and address.
`Error`	Default, when no conditions matched	An unexpected error occurred, so the module couldn’t return a result.

Input payload

The following is a sample payload used to submit identity data to the Data Verification module for processing.

JSON

{
  "resourceId": "your-journey-resourceID@latest",
  "context": {
    "subject": {
      "identity": {
        "currentAddress": {
          "administrativeArea": "AMAZONAS",
          "building": "1",
          "country": "COL",
          "locality": "Tabatinga",
          "postalCode": "910001",
          "thoroughfare": "ABC STREET"
        },
        "dateOfBirth": "2024-09-17",
        "firstName": "SAMUEL",
        "idNumbers": [
          {
            "country": "COL",
            "idNumber": "14502642",
            "type": "identityCard"
          }
        ],
        "lastNames": [
          "RODRIGUEZ"
        ]
      }
    }
  }
}

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {
      "customDecision": null,
      "gbgScore": 250,
      "idName": 0,
      "idNameAddress": 0,
      "idNameAddressDob": 0,
      "idNameDob": 0,
      "isUnder18": true,
      "nameAddress": 0,
      "nameDob": 0,
      "nameDobAddress": 0,
      "sources": 0
    },
    "outcome": "ALERT"
  }
}

Number of matching sources

Number of sources with any match type

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + address matches

Number of sources where Name and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + DOB matches

Number of sources where Name and Date of Birth matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + DOB + address matches

Number of sources where Name, Date of Birth, and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + name + address matches

Number of sources where ID number, Name, and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + name + DOB matches

Number of sources where ID number, Name, and Date of Birth matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + name + DOB + address matches

Number of sources where ID number, Name, Date of Birth, and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Is under 18

Indicates if the user is under 18 years old

Detail	Description
Type	Boolean
Default	`isFalse`

GBG score

GBG score for identity verification

Detail	Description
Type	Integer
Range	0–1000
Default	`0`

Colombia - Single Source

Capabilities

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`no result`	no result

Count of matches against name and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against name, address and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and either address or date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document and name

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document, name, address and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against name and address

Count of mmatches against name and address

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document, name and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and address match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and address and date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources with more than one field match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document, name and address

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	Supplier Decision is `match`	The data source confirms the subject’s identity.
`Partial Identity Match`	Supplier Decision is `partial match`	The data source partially confirms the subject’s identity.
`Identity Mismatch`	Supplier Decision is `mismatch`	The data source returns a mismatch for the subject’s details.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Could Not Locate`	Default, when no conditions matched	The module can’t find a record for the subject in the data source.

Input payload

The following is a sample payload used to submit data to the Colombia - Single Source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "12345678",
          "sortCode": "01-02-03",
          "type": "Bank Account"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Full",
        "idNumbers": [
          {
            "idNumber": "9001234567",
            "type": "identityCard"
          }
        ],
        "lastNames": [
          "Match"
        ],
        "middleNames": [
          "Good"
        ],
        "phones": [
          {
            "number": "+447795111111",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	Yes	The subject’s current residential address.
`DateOfBirth`	No	The subject’s date of birth.
`IdentityCard`	No	The number of the subject’s national identity card.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Identity Match"
  }
}

Czechia - Single Source

Capabilities

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`no result`	no result

Count of matches against name and address

Count of mmatches against name and address

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and address match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and address and date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against name and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources with more than one field match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against name, address and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and either address or date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	Supplier Decision is `match`	The data source confirms the subject’s identity.
`Partial Identity Match`	Supplier Decision is `partial match`	The data source partially confirms the subject’s identity.
`Identity Mismatch`	Supplier Decision is `mismatch`	The data source returns a mismatch for the subject’s details.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Could Not Locate`	Default, when no conditions matched	The module can’t find a record for the subject in the data source.

Input payload

The following is a sample payload used to submit data to the Czechia - Single Source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Full",
        "lastNames": [
          "Match"
        ],
        "middleNames": [
          "Good"
        ],
        "phones": [
          {
            "number": "+447795111111",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	Yes	The subject’s current residential address.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Identity Match"
  }
}

Denmark - Citizen source

Identity verification - Name, DOB, address, phone and email address

Capabilities

Generic email match result

Indicates if the email has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Initial matches

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Address line 1 match flag

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and (Date of Birth match result is `match` or Date of Birth match result is `partial match`) and (Overall Address match result is `match` or Overall Address match result is `partial match`)	The first name, last name, date of birth, and address all match or partially match.
`Partial Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and ((Date of Birth match result is `match` or Date of Birth match result is `partial match`) or (Overall Address match result is `match` or Overall Address match result is `partial match`))	The first and last names match or partially match, and either the date of birth or address matches or partially matches.
`Could Not Locate`	First Name match result is `not available` and Last Names match result is `not available`	The data source has no record of the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Denmark - Citizen source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	No	The subject’s current residential address.
`DateOfBirth`	Yes	The subject’s date of birth.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`OtherEmails`	No	Any additional email addresses associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Denmark: Single match

This variant performs a single-source identity verification check for Danish subjects.

Detail	Value
Required inputs	Determined by journey configuration
Optional inputs	None

The capabilities are the same as Argentina: Single match.

Default outcomes

The table below lists the default outcomes for this variant.

Outcome	Condition	Description
`ALERT`	Is under 18 is `true`	The subject is under 18.
`Match`	Name + DOB + Address ≥ 1 or ID + Name + Address ≥ 1 or ID + Name + DOB + Address ≥ 1	Full match through any strong element combination.
`Partial Match`	Name + Address ≥ 1 or Name + DOB ≥ 1	Partial match.
`No Match`	Name + Address < 1	No match.
`Error`	Default	An unexpected error occurred.

Input payload

The following is a sample payload used to submit data to the Denmark: Single match module for processing.

JSON

{
  "context": {
    "subject": {
      "identity": {
        "currentAddress": {
          "building": "99",
          "country": "DNK",
          "locality": "Ringkobing",
          "postalCode": "6950",
          "thoroughfare": "Skovsangervej"
        },
        "dateOfBirth": "2020-01-01",
        "firstName": "Fred",
        "idNumbers": [
          {
            "country": "DNK",
            "idNumber": "1811982643",
            "type": "identityCard"
          }
        ],
        "lastNames": [
          "Rasmussens"
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`IdentityCard`	Yes	The number of the subject’s national identity card.
`CurrentAddress/building`	No	The building name or number of the current address.
`CurrentAddress/thoroughfare`	No	The street or thoroughfare of the current address.
`CurrentAddress/locality`	No	The locality (town or city) of the current address.
`CurrentAddress/postalCode`	No	The postal or ZIP code of the current address.
`CurrentAddress/country`	Yes	The country of the current address.
`Gender`	No	The subject’s gender.
`LandlinePhone`	No	The subject’s landline telephone number.
`DateOfBirth`	No	The subject’s date of birth.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {
      "customDecision": null,
      "gbgScore": 203,
      "idName": 0,
      "idNameAddress": 0,
      "idNameAddressDob": 0,
      "idNameDob": 0,
      "isUnder18": true,
      "nameAddress": 0,
      "nameDob": 0,
      "nameDobAddress": 0,
      "sources": 0
    },
    "outcome": "ALERT"
  }
}

Number of matching sources

Number of sources with any match type

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + address matches

Number of sources where Name and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + DOB matches

Number of sources where Name and Date of Birth matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + DOB + address matches

Number of sources where Name, Date of Birth, and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + name + address matches

Number of sources where ID number, Name, and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + name + DOB matches

Number of sources where ID number, Name, and Date of Birth matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + name + DOB + address matches

Number of sources where ID number, Name, Date of Birth, and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Is under 18

Indicates if the user is under 18 years old

Detail	Description
Type	Boolean
Default	`isFalse`

GBG score

GBG score for identity verification

Detail	Description
Type	Integer
Range	0–1000
Default	`0`

Finland - Citizen source

Identity verification - Name, DOB, address, phone and email address

Capabilities

Generic email match result

Indicates if the email has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Initial matches

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Address line 1 match flag

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and (Date of Birth match result is `match` or Date of Birth match result is `partial match`) and (Overall Address match result is `match` or Overall Address match result is `partial match`)	The first name, last name, date of birth, and address all match or partially match.
`Partial Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and ((Date of Birth match result is `match` or Date of Birth match result is `partial match`) or (Overall Address match result is `match` or Overall Address match result is `partial match`))	The first and last names match or partially match, and either the date of birth or address matches or partially matches.
`Could Not Locate`	First Name match result is `not available` and Last Names match result is `not available`	The data source has no record of the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Finland - Citizen source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	No	The subject’s current residential address.
`DateOfBirth`	Yes	The subject’s date of birth.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`OtherEmails`	No	Any additional email addresses associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Finland - Single Source

Capabilities

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`no result`	no result

Count of matches against name and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against name, address and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and either address or date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document and name

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document, name, address and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against name and address

Count of mmatches against name and address

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document, name and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and address match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and address and date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources with more than one field match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document, name and address

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	Supplier Decision is `match`	The data source confirms the subject’s identity.
`Partial Identity Match`	Supplier Decision is `partial match`	The data source partially confirms the subject’s identity.
`Identity Mismatch`	Supplier Decision is `mismatch`	The data source returns a mismatch for the subject’s details.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Could Not Locate`	Default, when no conditions matched	The module can’t find a record for the subject in the data source.

Input payload

The following is a sample payload used to submit data to the Finland - Single Source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "12345678",
          "sortCode": "01-02-03",
          "type": "Bank Account"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Full",
        "idNumbers": [
          {
            "idNumber": "131052308T",
            "type": "identityCard"
          }
        ],
        "lastNames": [
          "Match"
        ],
        "middleNames": [
          "Good"
        ],
        "phones": [
          {
            "number": "+447795111111",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	Yes	The subject’s current residential address.
`DateOfBirth`	No	The subject’s date of birth.
`MobilePhone`	No	The subject’s mobile telephone number.
`WorkPhone`	No	The subject’s work telephone number.
`LandlinePhone`	No	The subject’s landline telephone number.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`IdentityCard`	No	The number of the subject’s national identity card.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Identity Match"
  }
}

France - Citizen source

Identity verification - Name, DOB, address, phone and email address

Capabilities

Generic email match result

Indicates if the email has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Initial matches

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Address line 1 match flag

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and (Date of Birth match result is `match` or Date of Birth match result is `partial match`) and (Overall Address match result is `match` or Overall Address match result is `partial match`)	The first name, last name, date of birth, and address all match or partially match.
`Partial Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and ((Date of Birth match result is `match` or Date of Birth match result is `partial match`) or (Overall Address match result is `match` or Overall Address match result is `partial match`))	The first and last names match or partially match, and either the date of birth or address matches or partially matches.
`Could Not Locate`	First Name match result is `not available` and Last Names match result is `not available`	The data source has no record of the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the France - Citizen source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	No	The subject’s current residential address.
`DateOfBirth`	Yes	The subject’s date of birth.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`OtherEmails`	No	Any additional email addresses associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

France Consumer

Capabilities

Generic email match result

Indicates if the email has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Building match result

Indicates if the current address’ building has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Middle names match result

Indicates if the middle names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Premise match result

Indicates if the current address’ premise has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Thoroughfare match result

Indicates if the current address’ thoroughfare has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	First Name match result is `match` and Last Names match result is `match` and Overall Address match result is `match` and Date of Birth match result is not `mismatch`	The first name, last name, and address match. The date of birth doesn’t conflict with the record.
`Partial Identity Match`	First Name match result is `match` and Last Names match result is `match` and (Date of Birth match result is `match` or Overall Address match result is `partial match`)	The first and last names match, and either the date of birth matches or the address partially matches.
`Could Not Locate`	Supplier Decision is `unrecognised value`	The data source returned a decision that the module doesn’t recognise, so the module can’t locate the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the France Consumer module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`MobilePhone`	No	The subject’s mobile telephone number.
`WorkPhone`	No	The subject’s work telephone number.
`LandlinePhone`	No	The subject’s landline telephone number.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`FullName`	Yes	The subject’s full name, including given and family names.
`FullName/firstName`	Yes	The subject’s first name.
`FullName/middleNames`	No	Any additional registered names of the subject.
`FullName/lastNames`	Yes	The subject’s last name or names.
`FullName/title`	No	The subject’s title, for example, Mr, Ms, or Dr.
`DateOfBirth`	Yes	The subject’s date of birth.
`CurrentAddress`	No	The subject’s current residential address.
`CurrentAddress/lines`	No	The full address as one or more free-form lines, used when structured address components are not available.
`CurrentAddress/addressString`	No	The full address as a single line.
`CurrentAddress/premise`	No	The premise (building name or number) of the current address.
`CurrentAddress/building`	No	The building name or number of the current address.
`CurrentAddress/subBuilding`	No	The sub-building (for example, flat or unit) of the current address.
`CurrentAddress/thoroughfare`	No	The street or thoroughfare of the current address.
`CurrentAddress/dependentThoroughfare`	No	The dependent thoroughfare (a smaller street within the thoroughfare) of the current address.
`CurrentAddress/locality`	No	The locality (town or city) of the current address.
`CurrentAddress/dependentLocality`	No	The dependent locality (a smaller area within the locality) of the current address.
`CurrentAddress/doubleDependentLocality`	No	The double dependent locality (a smaller area within the dependent locality) of the current address.
`CurrentAddress/postalCode`	No	The postal or ZIP code of the current address.
`CurrentAddress/postBox`	No	The post office box of the current address.
`CurrentAddress/country`	No	The country of the current address.
`CurrentAddress/superAdministrativeArea`	No	The super-administrative area (a larger region above the administrative area) of the current address.
`CurrentAddress/administrativeArea`	No	The administrative area (for example, state, province, or county) of the current address.
`CurrentAddress/subAdministrativeArea`	No	The sub-administrative area (a smaller region within the administrative area) of the current address.
`CurrentAddress/organization`	No	The company or organization associated with the current address.
`CurrentAddress/location`	No	The geographic location (coordinates) of the current address.
`PersonalEmail`	No	The subject’s personal email address.
`WorkEmail`	No	The subject’s work email address.
`OtherEmails`	No	Any additional email addresses associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

France - Residential

Capabilities

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Building match result

Indicates if the current address’ building has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Middle names match result

Indicates if the middle names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Premise match result

Indicates if the current address’ premise has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Thoroughfare match result

Indicates if the current address’ thoroughfare has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Mobile phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	First Name match result is `match` and Last Names match result is `match` and Date of Birth match result is not `mismatch` and Overall Address match result is `match`	The first name, last name, and address match. The date of birth doesn’t conflict with the record.
`Partial Identity Match`	First Name match result is `match` and Last Names match result is `match` and (Date of Birth match result is `match` or Overall Address match result is `partial match`)	The first and last names match, and either the date of birth matches or the address partially matches.
`Could Not Locate`	Supplier Decision is `unrecognised value`	The data source returned a decision that the module doesn’t recognise, so the module can’t locate the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the France - Residential module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`MobilePhone`	No	The subject’s mobile telephone number.
`FullName`	Yes	The subject’s full name, including given and family names.
`FullName/firstName`	Yes	The subject’s first name.
`FullName/middleNames`	No	Any additional registered names of the subject.
`FullName/lastNames`	Yes	The subject’s last name or names.
`FullName/title`	No	The subject’s title, for example, Mr, Ms, or Dr.
`DateOfBirth`	Yes	The subject’s date of birth.
`CurrentAddress`	Yes	The subject’s current residential address.
`CurrentAddress/lines`	No	The full address as one or more free-form lines, used when structured address components are not available.
`CurrentAddress/addressString`	No	The full address as a single line.
`CurrentAddress/premise`	No	The premise (building name or number) of the current address.
`CurrentAddress/building`	No	The building name or number of the current address.
`CurrentAddress/subBuilding`	No	The sub-building (for example, flat or unit) of the current address.
`CurrentAddress/thoroughfare`	No	The street or thoroughfare of the current address.
`CurrentAddress/dependentThoroughfare`	No	The dependent thoroughfare (a smaller street within the thoroughfare) of the current address.
`CurrentAddress/locality`	No	The locality (town or city) of the current address.
`CurrentAddress/dependentLocality`	No	The dependent locality (a smaller area within the locality) of the current address.
`CurrentAddress/doubleDependentLocality`	No	The double dependent locality (a smaller area within the dependent locality) of the current address.
`CurrentAddress/postalCode`	No	The postal or ZIP code of the current address.
`CurrentAddress/postBox`	No	The post office box of the current address.
`CurrentAddress/country`	No	The country of the current address.
`CurrentAddress/superAdministrativeArea`	No	The super-administrative area (a larger region above the administrative area) of the current address.
`CurrentAddress/administrativeArea`	No	The administrative area (for example, state, province, or county) of the current address.
`CurrentAddress/subAdministrativeArea`	No	The sub-administrative area (a smaller region within the administrative area) of the current address.
`CurrentAddress/organization`	No	The company or organization associated with the current address.
`CurrentAddress/location`	No	The geographic location (coordinates) of the current address.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

France Residential 3

Capabilities

Generic email match result

Indicates if the email has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Building match result

Indicates if the current address’ building has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Middle names match result

Indicates if the middle names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Premise match result

Indicates if the current address’ premise has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Thoroughfare match result

Indicates if the current address’ thoroughfare has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	First Name match result is `match` and Last Names match result is `match` and Overall Address match result is `match` and Date of Birth match result is not `mismatch`	The first name, last name, and address match. The date of birth doesn’t conflict with the record.
`Partial Identity Match`	First Name match result is `match` and Last Names match result is `match` and (Date of Birth match result is `match` or Overall Address match result is `partial match`)	The first and last names match, and either the date of birth matches or the address partially matches.
`Could Not Locate`	Supplier Decision is `unrecognised value`	The data source returned a decision that the module doesn’t recognise, so the module can’t locate the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the France Residential 3 module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`MobilePhone`	No	The subject’s mobile telephone number.
`WorkPhone`	No	The subject’s work telephone number.
`LandlinePhone`	No	The subject’s landline telephone number.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`FullName`	Yes	The subject’s full name, including given and family names.
`FullName/firstName`	Yes	The subject’s first name.
`FullName/middleNames`	No	Any additional registered names of the subject.
`FullName/lastNames`	Yes	The subject’s last name or names.
`FullName/title`	No	The subject’s title, for example, Mr, Ms, or Dr.
`DateOfBirth`	Yes	The subject’s date of birth.
`CurrentAddress`	No	The subject’s current residential address.
`CurrentAddress/lines`	No	The full address as one or more free-form lines, used when structured address components are not available.
`CurrentAddress/addressString`	No	The full address as a single line.
`CurrentAddress/premise`	No	The premise (building name or number) of the current address.
`CurrentAddress/building`	No	The building name or number of the current address.
`CurrentAddress/subBuilding`	No	The sub-building (for example, flat or unit) of the current address.
`CurrentAddress/thoroughfare`	No	The street or thoroughfare of the current address.
`CurrentAddress/dependentThoroughfare`	No	The dependent thoroughfare (a smaller street within the thoroughfare) of the current address.
`CurrentAddress/locality`	No	The locality (town or city) of the current address.
`CurrentAddress/dependentLocality`	No	The dependent locality (a smaller area within the locality) of the current address.
`CurrentAddress/doubleDependentLocality`	No	The double dependent locality (a smaller area within the dependent locality) of the current address.
`CurrentAddress/postalCode`	No	The postal or ZIP code of the current address.
`CurrentAddress/postBox`	No	The post office box of the current address.
`CurrentAddress/country`	No	The country of the current address.
`CurrentAddress/superAdministrativeArea`	No	The super-administrative area (a larger region above the administrative area) of the current address.
`CurrentAddress/administrativeArea`	No	The administrative area (for example, state, province, or county) of the current address.
`CurrentAddress/subAdministrativeArea`	No	The sub-administrative area (a smaller region within the administrative area) of the current address.
`CurrentAddress/organization`	No	The company or organization associated with the current address.
`CurrentAddress/location`	No	The geographic location (coordinates) of the current address.
`PersonalEmail`	No	The subject’s personal email address.
`WorkEmail`	No	The subject’s work email address.
`OtherEmails`	No	Any additional email addresses associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

France: Single match

Performs a single-source identity verification check for French subjects, requiring a landline phone number as an input.

Detail	Value
Required inputs	Full name, current address, landline phone
Optional inputs	Date of birth

The capabilities are the same as Argentina: Single match.

Default outcomes

The table below lists the default outcomes for this variant.

Outcome	Condition	Description
`ALERT`	Is under 18 is `true`	The subject is under 18.
`Match`	Name + DOB + Address ≥ 1	Full match.
`Partial Match`	Name + Address ≥ 1 or Name + DOB ≥ 1	Partial match.
`No Match`	Name + Address < 1	No match.
`Error`	Default	An unexpected error occurred.

Input payload

The following is a sample payload used to submit data to the France: Single match module for processing.

JSON

{
  "context": {
    "subject": {
      "identity": {
        "currentAddress": {
          "building": "166",
          "country": "FRA",
          "locality": "OSTWALD",
          "postalCode": "67540",
          "thoroughfare": "RUE DU GENERAL LECLERC"
        },
        "dateOfBirth": "2020-01-08",
        "firstName": "Simon",
        "lastNames": [
          "MARMION"
        ],
        "phones": [
          {
            "number": "+33955501000",
            "type": "Landline"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress/building`	Yes	The building name or number of the current address.
`CurrentAddress/thoroughfare`	No	The street or thoroughfare of the current address.
`CurrentAddress/locality`	No	The locality (town or city) of the current address.
`CurrentAddress/postalCode`	Yes	The postal or ZIP code of the current address.
`CurrentAddress/country`	No	The country of the current address.
`LandlinePhone`	No	The subject’s landline telephone number.
`DateOfBirth`	No	The subject’s date of birth.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {
      "customDecision": null,
      "gbgScore": 609,
      "idName": 0,
      "idNameAddress": 0,
      "idNameAddressDob": 0,
      "idNameDob": 0,
      "isUnder18": true,
      "nameAddress": 3,
      "nameDob": 0,
      "nameDobAddress": 0,
      "sources": 3
    },
    "outcome": "ALERT"
  }
}

Number of matching sources

Number of sources with any match type

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + address matches

Number of sources where Name and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + DOB matches

Number of sources where Name and Date of Birth matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + DOB + address matches

Number of sources where Name, Date of Birth, and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + name + address matches

Number of sources where ID number, Name, and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + name + DOB matches

Number of sources where ID number, Name, and Date of Birth matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + name + DOB + address matches

Number of sources where ID number, Name, Date of Birth, and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Is under 18

Indicates if the user is under 18 years old

Detail	Description
Type	Boolean
Default	`isFalse`

GBG score

GBG score for identity verification

Detail	Description
Type	Integer
Range	0–1000
Default	`0`

France - Single Source

France identity check searching for a single source match

Capabilities

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`no result`	no result

Count of matches against name and address

Count of mmatches against name and address

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and address match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and address and date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against name and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources with more than one field match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against name, address and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and either address or date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	Supplier Decision is `match`	The data source confirms the subject’s identity.
`Partial Identity Match`	Supplier Decision is `partial match`	The data source partially confirms the subject’s identity.
`Identity Mismatch`	Supplier Decision is `mismatch`	The data source returns a mismatch for the subject’s details.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Could Not Locate`	Default, when no conditions matched	The module can’t find a record for the subject in the data source.

Input payload

The following is a sample payload used to submit data to the France - Single Source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "12345678",
          "sortCode": "01-02-03",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "111",
          "number": "NZ111111",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Full",
        "lastNames": [
          "Match"
        ],
        "middleNames": [
          "Good"
        ],
        "phones": [
          {
            "number": "+447795111111",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	Yes	The subject’s current residential address.
`DateOfBirth`	No	The subject’s date of birth.
`MobilePhone`	No	The subject’s mobile telephone number.
`WorkPhone`	No	The subject’s work telephone number.
`LandlinePhone`	No	The subject’s landline telephone number.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Identity Match"
  }
}

France - Utility 2

Capabilities

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Building match result

Indicates if the current address’ building has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Middle names match result

Indicates if the middle names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Premise match result

Indicates if the current address’ premise has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Thoroughfare match result

Indicates if the current address’ thoroughfare has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Mobile phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	First Name match result is `match` and Last Names match result is `match` and Date of Birth match result is not `mismatch` and Overall Address match result is `match`	The first name, last name, and address match. The date of birth doesn’t conflict with the record.
`Partial Identity Match`	First Name match result is `match` and Last Names match result is `match` and (Date of Birth match result is `match` or Overall Address match result is `partial match`)	The first and last names match, and either the date of birth matches or the address partially matches.
`Could Not Locate`	Supplier Decision is `unrecognised value`	The data source returned a decision that the module doesn’t recognise, so the module can’t locate the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the France - Utility 2 module for processing.

JSON

{
  "context": {
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      },
      "uid": "variant-test-user"
    }
  }
}

Field	Required	Description
`MobilePhone`	No	The subject’s mobile telephone number.
`FullName`	Yes	The subject’s full name, including given and family names.
`FullName/firstName`	Yes	The subject’s first name.
`FullName/middleNames`	No	Any additional registered names of the subject.
`FullName/lastNames`	Yes	The subject’s last name or names.
`FullName/title`	No	The subject’s title, for example, Mr, Ms, or Dr.
`DateOfBirth`	Yes	The subject’s date of birth.
`CurrentAddress`	Yes	The subject’s current residential address.
`CurrentAddress/lines`	No	The full address as one or more free-form lines, used when structured address components are not available.
`CurrentAddress/addressString`	No	The full address as a single line.
`CurrentAddress/premise`	No	The premise (building name or number) of the current address.
`CurrentAddress/building`	No	The building name or number of the current address.
`CurrentAddress/subBuilding`	No	The sub-building (for example, flat or unit) of the current address.
`CurrentAddress/thoroughfare`	No	The street or thoroughfare of the current address.
`CurrentAddress/dependentThoroughfare`	No	The dependent thoroughfare (a smaller street within the thoroughfare) of the current address.
`CurrentAddress/locality`	No	The locality (town or city) of the current address.
`CurrentAddress/dependentLocality`	No	The dependent locality (a smaller area within the locality) of the current address.
`CurrentAddress/doubleDependentLocality`	No	The double dependent locality (a smaller area within the dependent locality) of the current address.
`CurrentAddress/postalCode`	No	The postal or ZIP code of the current address.
`CurrentAddress/postBox`	No	The post office box of the current address.
`CurrentAddress/country`	No	The country of the current address.
`CurrentAddress/superAdministrativeArea`	No	The super-administrative area (a larger region above the administrative area) of the current address.
`CurrentAddress/administrativeArea`	No	The administrative area (for example, state, province, or county) of the current address.
`CurrentAddress/subAdministrativeArea`	No	The sub-administrative area (a smaller region within the administrative area) of the current address.
`CurrentAddress/organization`	No	The company or organization associated with the current address.
`CurrentAddress/location`	No	The geographic location (coordinates) of the current address.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Germany - Citizen source

Identity verification - Name, DOB, address, phone and email address

Capabilities

Generic email match result

Indicates if the email has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Initial matches

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Address line 1 match flag

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and (Date of Birth match result is `match` or Date of Birth match result is `partial match`) and (Overall Address match result is `match` or Overall Address match result is `partial match`)	The first name, last name, date of birth, and address all match or partially match.
`Partial Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and ((Date of Birth match result is `match` or Date of Birth match result is `partial match`) or (Overall Address match result is `match` or Overall Address match result is `partial match`))	The first and last names match or partially match, and either the date of birth or address matches or partially matches.
`Could Not Locate`	First Name match result is `not available` and Last Names match result is `not available`	The data source has no record of the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Germany - Citizen source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	No	The subject’s current residential address.
`DateOfBirth`	Yes	The subject’s date of birth.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`OtherEmails`	No	Any additional email addresses associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Germany Consumer

Capabilities

Generic email match result

Indicates if the email has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Building match result

Indicates if the current address’ building has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Middle names match result

Indicates if the middle names matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Premise match result

Indicates if the current address’ premise has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Thoroughfare match result

Indicates if the current address’ thoroughfare has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result
`partial match`	partial match

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	First Name match result is `match` and Last Names match result is `match` and Overall Address match result is `match` and Date of Birth match result is not `mismatch`	The first name, last name, and address match. The date of birth doesn’t conflict with the record.
`Partial Identity Match`	First Name match result is `match` and Last Names match result is `match` and (Date of Birth match result is `match` or Overall Address match result is `partial match`)	The first and last names match, and either the date of birth matches or the address partially matches.
`Could Not Locate`	Supplier Decision is `unrecognised value`	The data source returned a decision that the module doesn’t recognise, so the module can’t locate the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Germany Consumer module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`MobilePhone`	No	The subject’s mobile telephone number.
`WorkPhone`	No	The subject’s work telephone number.
`LandlinePhone`	No	The subject’s landline telephone number.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`FullName`	Yes	The subject’s full name, including given and family names.
`FullName/firstName`	Yes	The subject’s first name.
`FullName/middleNames`	No	Any additional registered names of the subject.
`FullName/lastNames`	Yes	The subject’s last name or names.
`FullName/title`	No	The subject’s title, for example, Mr, Ms, or Dr.
`DateOfBirth`	Yes	The subject’s date of birth.
`CurrentAddress`	No	The subject’s current residential address.
`CurrentAddress/lines`	No	The full address as one or more free-form lines, used when structured address components are not available.
`CurrentAddress/addressString`	No	The full address as a single line.
`CurrentAddress/premise`	No	The premise (building name or number) of the current address.
`CurrentAddress/building`	No	The building name or number of the current address.
`CurrentAddress/subBuilding`	No	The sub-building (for example, flat or unit) of the current address.
`CurrentAddress/thoroughfare`	No	The street or thoroughfare of the current address.
`CurrentAddress/dependentThoroughfare`	No	The dependent thoroughfare (a smaller street within the thoroughfare) of the current address.
`CurrentAddress/locality`	No	The locality (town or city) of the current address.
`CurrentAddress/dependentLocality`	No	The dependent locality (a smaller area within the locality) of the current address.
`CurrentAddress/doubleDependentLocality`	No	The double dependent locality (a smaller area within the dependent locality) of the current address.
`CurrentAddress/postalCode`	No	The postal or ZIP code of the current address.
`CurrentAddress/postBox`	No	The post office box of the current address.
`CurrentAddress/country`	No	The country of the current address.
`CurrentAddress/superAdministrativeArea`	No	The super-administrative area (a larger region above the administrative area) of the current address.
`CurrentAddress/administrativeArea`	No	The administrative area (for example, state, province, or county) of the current address.
`CurrentAddress/subAdministrativeArea`	No	The sub-administrative area (a smaller region within the administrative area) of the current address.
`CurrentAddress/organization`	No	The company or organization associated with the current address.
`CurrentAddress/location`	No	The geographic location (coordinates) of the current address.
`PersonalEmail`	No	The subject’s personal email address.
`WorkEmail`	No	The subject’s work email address.
`OtherEmails`	No	Any additional email addresses associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Germany Credit Bureau

Capabilities

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Building match result

Indicates if the current address’ building has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Middle names match result

Indicates if the middle names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Premise match result

Indicates if the current address’ premise has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Thoroughfare match result

Indicates if the current address’ thoroughfare has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	First Name match result is `match` and Last Names match result is `match` and Date of Birth match result is not `mismatch` and Overall Address match result is `match`	The first name, last name, and address match. The date of birth doesn’t conflict with the record.
`Partial Identity Match`	First Name match result is `match` and Last Names match result is `match` and (Date of Birth match result is `match` or Overall Address match result is `partial match`)	The first and last names match, and either the date of birth matches or the address partially matches.
`Could Not Locate`	Supplier Decision is `unrecognised value`	The data source returned a decision that the module doesn’t recognise, so the module can’t locate the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Germany Credit Bureau module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`FullName/firstName`	Yes	The subject’s first name.
`FullName/middleNames`	No	Any additional registered names of the subject.
`FullName/lastNames`	Yes	The subject’s last name or names.
`FullName/title`	No	The subject’s title, for example, Mr, Ms, or Dr.
`DateOfBirth`	Yes	The subject’s date of birth.
`CurrentAddress`	Yes	The subject’s current residential address.
`CurrentAddress/lines`	No	The full address as one or more free-form lines, used when structured address components are not available.
`CurrentAddress/addressString`	No	The full address as a single line.
`CurrentAddress/premise`	No	The premise (building name or number) of the current address.
`CurrentAddress/building`	No	The building name or number of the current address.
`CurrentAddress/subBuilding`	No	The sub-building (for example, flat or unit) of the current address.
`CurrentAddress/thoroughfare`	No	The street or thoroughfare of the current address.
`CurrentAddress/dependentThoroughfare`	No	The dependent thoroughfare (a smaller street within the thoroughfare) of the current address.
`CurrentAddress/locality`	No	The locality (town or city) of the current address.
`CurrentAddress/dependentLocality`	No	The dependent locality (a smaller area within the locality) of the current address.
`CurrentAddress/doubleDependentLocality`	No	The double dependent locality (a smaller area within the dependent locality) of the current address.
`CurrentAddress/postalCode`	No	The postal or ZIP code of the current address.
`CurrentAddress/postBox`	No	The post office box of the current address.
`CurrentAddress/country`	No	The country of the current address.
`CurrentAddress/superAdministrativeArea`	No	The super-administrative area (a larger region above the administrative area) of the current address.
`CurrentAddress/administrativeArea`	No	The administrative area (for example, state, province, or county) of the current address.
`CurrentAddress/subAdministrativeArea`	No	The sub-administrative area (a smaller region within the administrative area) of the current address.
`CurrentAddress/organization`	No	The company or organization associated with the current address.
`CurrentAddress/location`	No	The geographic location (coordinates) of the current address.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Germany: Schufa

Verifies German subjects against Schufa, Germany’s leading credit bureau, returning field-level match flags showing which identity elements matched.

Detail	Value
Required inputs	Full name, date of birth, current address
Optional inputs	None

Capabilities

The capabilities returned by this variant are grouped into name, address, and other match flags.

Name match flags

Match results for the subject’s first and last names against the Schufa record.

Capability	Values	Description
First name matches	`match`, `partial match`, `mismatch`, `no result`, `unrecognised value`	Match result for the subject’s first name against the Schufa record.
Last names matches	`match`, `partial match`, `mismatch`, `no result`, `unrecognised value`	Match result for the subject’s last name.

Address match flags

Match results for the subject’s address, both overall and at the component level.

Capability	Values	Description
Address match flag	`match`, `partial match`, `mismatch`, `no result`, `unrecognised value`	Overall address match result.
Thoroughfare matches	Same values	Match result for the street name.
Locality matches	Same values	Match result for the city or town.
Postal code matches	Same values	Match result for the postal code.

Other match flags

Date of birth and the Schufa QBit (quality indicator) flag.

Capability	Values	Description
Date of birth matches	`match`, `partial match`, `mismatch`, `no result`, `unrecognised value`	Match result for the subject’s date of birth.
QBit present flag	`Y`, `N`, `no result`	Indicates whether a Schufa QBit (quality indicator) is present for the subject. A QBit confirms that Schufa holds a verified record for the subject, which increases verification confidence independently of the individual field matches.

Default outcomes

The table below lists the default outcomes for this variant.

Outcome	Condition	Description
`Identity Match`	First name matches or partially matches and last name matches or partially matches and DOB matches or partially matches and address matches or partially matches and QBit is present	Full identity match. All key elements confirmed against the Schufa record, and Schufa holds a verified record for the subject.
`Partial Identity Match`	First name matches or partially matches and last name matches or partially matches and DOB matches or partially matches or address matches or partially matches	Name confirmed, plus either DOB or address, but not both alongside QBit.
`Identity Mismatch`	Default (no conditions matched)	No verification path produced a passing result.
`Error`	—	A system or data source error stopped the check from completing.

For a full explanation of match flag values, see match flags in the glossary.

Input payload

The following is a sample payload used to submit data to the Germany: Schufa module for processing.

JSON

{
  "context": {
    "subject": {
      "identity": {
        "currentAddress": {
          "building": "5",
          "country": "DEU",
          "locality": "ESSLINGEN",
          "postalCode": "73730",
          "thoroughfare": "EINSTEINSTR"
        },
        "dateOfBirth": "1979-09-12",
        "firstName": "HUETTEN-ZAUBER",
        "lastNames": [
          "FLORIAN"
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`DateOfBirth`	Yes	The subject’s date of birth.
`CurrentAddress/building`	No	The building name or number of the current address.
`CurrentAddress/thoroughfare`	Yes	The street or thoroughfare of the current address.
`CurrentAddress/locality`	Yes	The locality (town or city) of the current address.
`CurrentAddress/postalCode`	Yes	The postal or ZIP code of the current address.
`CurrentAddress/country`	Yes	The country of the current address.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {
      "QBitPresentFlag": "Y",
      "addressMatchFlag": "match",
      "dateOfBirthMatchFlag": "match",
      "firstNameMatchFlag": "match",
      "lastNamesMatchFlag": "match",
      "localityMatchFlag": "match",
      "postalCodeMatchFlag": "match",
      "thoroughfareMatchFlag": "match"
    },
    "outcome": "Identity Match"
  }
}

Germany: Single match without Schufa

This variant performs a single-source identity verification check for German subjects using non-Schufa data sources (consumer and public record databases).

Detail	Value
Required inputs	Full name, date of birth, current address
Optional inputs	Gender, mobile phone, landline phone

The capabilities are the same as Argentina: Single match.

Default outcomes

The table below lists the default outcomes for this variant.

Outcome	Condition	Description
`ALERT`	Is under 18 is `true`	The subject is under 18.
`Match`	Name + DOB + Address ≥ 1	Full match.
`Partial Match`	Name + Address ≥ 1 or Name + DOB ≥ 1	Partial match.
`No Match`	Name + Address < 1	No match.
`Error`	Default	An unexpected error occurred.

Input payload

The following is a sample payload used to submit data to the Germany: Single match without Schufa module for processing.

JSON

{
  "context": {
    "subject": {
      "identity": {
        "currentAddress": {
          "building": "2",
          "country": "DEU",
          "locality": "Glucksburg",
          "postalCode": "24960",
          "thoroughfare": "Rathausstr."
        },
        "dateOfBirth": "2024-04-14",
        "firstName": "Someone",
        "lastNames": [
          "Else"
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`DateOfBirth`	Yes	The subject’s date of birth.
`CurrentAddress/building`	Yes	The building name or number of the current address.
`CurrentAddress/thoroughfare`	Yes	The street or thoroughfare of the current address.
`CurrentAddress/locality`	Yes	The locality (town or city) of the current address.
`CurrentAddress/postalCode`	Yes	The postal or ZIP code of the current address.
`CurrentAddress/country`	Yes	The country of the current address.
`Gender`	No	The subject’s gender.
`MobilePhone`	No	The subject’s mobile telephone number.
`LandlinePhone`	No	The subject’s landline telephone number.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {
      "customDecision": null,
      "gbgScore": 0,
      "idName": 0,
      "idNameAddress": 0,
      "idNameAddressDob": 0,
      "idNameDob": 0,
      "isUnder18": true,
      "nameAddress": 0,
      "nameDob": 0,
      "nameDobAddress": 0,
      "sources": 0
    },
    "outcome": "ALERT"
  }
}

Number of matching sources

Number of sources with any match type

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + address matches

Number of sources where Name and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + DOB matches

Number of sources where Name and Date of Birth matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Name + DOB + address matches

Number of sources where Name, Date of Birth, and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + name + address matches

Number of sources where ID number, Name, and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + name + DOB matches

Number of sources where ID number, Name, and Date of Birth matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

ID + name + DOB + address matches

Number of sources where ID number, Name, Date of Birth, and Address matched

Detail	Description
Type	Integer
Range	0–5
Default	`0`

Is under 18

Indicates if the user is under 18 years old

Detail	Description
Type	Boolean
Default	`isFalse`

GBG score

GBG score for identity verification

Detail	Description
Type	Integer
Range	0–1000
Default	`0`

Ghana - Single Source

Capabilities

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`no result`	no result

Count of matches against name and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against name, address and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and either address or date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document and name

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document, name, address and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against name and address

Count of mmatches against name and address

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document, name and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and address match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and address and date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources with more than one field match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document, name and address

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	Supplier Decision is `match`	The data source confirms the subject’s identity.
`Partial Identity Match`	Supplier Decision is `partial match`	The data source partially confirms the subject’s identity.
`Identity Mismatch`	Supplier Decision is `mismatch`	The data source returns a mismatch for the subject’s details.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Could Not Locate`	Default, when no conditions matched	The module can’t find a record for the subject in the data source.

Input payload

The following is a sample payload used to submit data to the Ghana - Single Source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "12345678",
          "sortCode": "01-02-03",
          "type": "Bank Account"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Full",
        "idNumbers": [
          {
            "idNumber": "A123456789012",
            "type": "identityCard"
          }
        ],
        "lastNames": [
          "Match"
        ],
        "middleNames": [
          "Good"
        ],
        "phones": [
          {
            "number": "+447795111111",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`DateOfBirth`	No	The subject’s date of birth.
`MobilePhone`	No	The subject’s mobile telephone number.
`WorkPhone`	No	The subject’s work telephone number.
`LandlinePhone`	No	The subject’s landline telephone number.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`IdentityCard`	Yes	The number of the subject’s national identity card.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Identity Match"
  }
}

Hungary - Citizen source

Identity verification - Name, DOB, address, phone and email address

Capabilities

Generic email match result

Indicates if the email has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Initial matches

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Address line 1 match flag

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and (Date of Birth match result is `match` or Date of Birth match result is `partial match`) and (Overall Address match result is `match` or Overall Address match result is `partial match`)	The first name, last name, date of birth, and address all match or partially match.
`Partial Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and ((Date of Birth match result is `match` or Date of Birth match result is `partial match`) or (Overall Address match result is `match` or Overall Address match result is `partial match`))	The first and last names match or partially match, and either the date of birth or address matches or partially matches.
`Could Not Locate`	First Name match result is `not available` and Last Names match result is `not available`	The data source has no record of the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Hungary - Citizen source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	No	The subject’s current residential address.
`DateOfBirth`	Yes	The subject’s date of birth.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`OtherEmails`	No	Any additional email addresses associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

India Aadhaar card

Capabilities

Middle names match result

Indicates if the middle names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

ID card number match result

Indicates if the document has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	First Name match result is `match` and Last Names match result is `match` and Date of Birth match result is `match` and ID Card number match result is `match`	The first name, last name, date of birth, and ID card number all match.
`Identity Mismatch`	First Name match result is `mismatch` or Last Names match result is `mismatch` or Date of Birth match result is `mismatch` or ID Card number match result is `mismatch`	At least one of the first name, last name, date of birth, or ID card number doesn’t match.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Could Not Locate`	Default, when no conditions matched	The module can’t find a record for the subject in the data source.

Input payload

The following is a sample payload used to submit data to the India Aadhaar card module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "12345678",
          "sortCode": "01-02-03",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "number": "123456789012",
          "type": "ID Card"
        },
        {
          "number": "1111111111",
          "type": "Tax ID"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Full",
        "lastNames": [
          "Match"
        ],
        "middleNames": [
          "Good"
        ],
        "phones": [
          {
            "number": "+447795111111",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`FullName/firstName`	Yes	The subject’s first name.
`FullName/middleNames`	No	Any additional registered names of the subject.
`FullName/lastNames`	Yes	The subject’s last name or names.
`FullName/title`	No	The subject’s title, for example, Mr, Ms, or Dr.
`DateOfBirth`	Yes	The subject’s date of birth.
`IdentityCard`	Yes	The number of the subject’s national identity card.
`IdNumbers`	Yes	The subject’s identity document numbers, each with the type of document it belongs to.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Identity Match"
  }
}

Indonesia - Citizen source

Identity verification - Name, DOB, address, phone and email address

Capabilities

Generic email match result

Indicates if the email has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Initial matches

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Address line 1 match flag

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and (Date of Birth match result is `match` or Date of Birth match result is `partial match`) and (Overall Address match result is `match` or Overall Address match result is `partial match`)	The first name, last name, date of birth, and address all match or partially match.
`Partial Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and ((Date of Birth match result is `match` or Date of Birth match result is `match`) or (Overall Address match result is `match` or Overall Address match result is `partial match`))	The first and last names match or partially match. Either the date of birth matches, or the address matches or partially matches.
`Could Not Locate`	First Name match result is `not available` and Last Names match result is `not available`	The data source has no record of the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Indonesia - Citizen source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	No	The subject’s current residential address.
`DateOfBirth`	Yes	The subject’s date of birth.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`OtherEmails`	No	Any additional email addresses associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Indonesia - Single Source

Capabilities

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`no result`	no result

Count of matches against name and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against name, address and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and either address or date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document and name

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document, name, address and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against name and address

Count of mmatches against name and address

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document, name and date of birth

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and address match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and address and date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources with more than one field match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Count of matches against document, name and address

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Total sources where name and date of birth match

Detail	Description
Type	Integer
Range	0–3
Default	`0`

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	Supplier Decision is `match`	The data source confirms the subject’s identity.
`Partial Identity Match`	Supplier Decision is `partial match`	The data source partially confirms the subject’s identity.
`Identity Mismatch`	Supplier Decision is `mismatch`	The data source returns a mismatch for the subject’s details.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Could Not Locate`	Default, when no conditions matched	The module can’t find a record for the subject in the data source.

Input payload

The following is a sample payload used to submit data to the Indonesia - Single Source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "12345678",
          "sortCode": "01-02-03",
          "type": "Bank Account"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "1A",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Full",
        "idNumbers": [
          {
            "idNumber": "1234567809123456",
            "type": "identityCard"
          }
        ],
        "lastNames": [
          "Match"
        ],
        "middleNames": [
          "Good"
        ],
        "phones": [
          {
            "number": "+447795111111",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`DateOfBirth`	Yes	The subject’s date of birth.
`MobilePhone`	No	The subject’s mobile telephone number.
`WorkPhone`	No	The subject’s work telephone number.
`LandlinePhone`	No	The subject’s landline telephone number.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`IdentityCard`	Yes	The number of the subject’s national identity card.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Identity Match"
  }
}

Ireland - Citizen source

Identity verification - Name, DOB, address, phone and email address

Capabilities

Generic email match result

Indicates if the email has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Initial matches

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Address line 1 match flag

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Generic phone match result

Indicates if the phone number has matched

Value	Description
`match`	match
`mismatch`	mismatch
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and (Date of Birth match result is `match` or Date of Birth match result is `partial match`) and (Overall Address match result is `match` or Overall Address match result is `partial match`)	The first name, last name, date of birth, and address all match or partially match.
`Partial Identity Match`	(First Name match result is `match` or First Name match result is `partial match`) and (Last Names match result is `match` or Last Names match result is `partial match`) and ((Date of Birth match result is `match` or Date of Birth match result is `partial match`) or (Overall Address match result is `match` or Overall Address match result is `partial match`))	The first and last names match or partially match, and either the date of birth or address matches or partially matches.
`Could Not Locate`	First Name match result is `not available` and Last Names match result is `not available`	The data source has no record of the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

Input payload

The following is a sample payload used to submit data to the Ireland - Citizen source module for processing.

JSON

{
  "context": {
    "config": {
      "_mockMode": "on"
    },
    "subject": {
      "accounts": [
        {
          "accountNumber": "00000000",
          "sortCode": "00-00-00",
          "type": "Bank Account"
        }
      ],
      "documents": [
        {
          "cardNumber": "000",
          "number": "NZ000000",
          "type": "Driving License"
        }
      ],
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "premise": "0",
          "thoroughfare": "The Street"
        },
        "dateOfBirth": "2007-03-26",
        "firstName": "Missing",
        "lastNames": [
          "Person"
        ],
        "phones": [
          {
            "number": "+447700000000",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`CurrentAddress`	No	The subject’s current residential address.
`DateOfBirth`	Yes	The subject’s date of birth.
`OtherPhones`	No	Any additional telephone numbers associated with the subject.
`OtherEmails`	No	Any additional email addresses associated with the subject.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {},
    "outcome": "Could Not Locate"
  }
}

Ireland Credit Bureau

Capabilities

Input address quality level

A broad indicator of the input address quality

Value	Description
`1`	Excellent Quality
`2`	Good Quality
`3`	Poor
`4`	not possible to validate

Date of birth match result

Indicates if the date of birth has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Supplier decision

Suppliers overall match decision

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Building match result

Indicates if the current address’ building has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Postal code match result

Indicates if the current address’ postalCode has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Middle names match result

Indicates if the middle names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Locality match result

Indicates if the current address’ locality has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

First name match result

Indicates if the first name has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Administrative area match result

Indicates if the current address’ administrativeArea has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Last names match result

Indicates if the last names matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Premise match result

Indicates if the current address’ premise has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Thoroughfare match result

Indicates if the current address’ thoroughfare has matched

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Overall address match result

Indicates if the current address is an overall match

Value	Description
`match`	match
`mismatch`	mismatch
`partial match`	partial match
`not available`	not available
`unrecognised value`	unrecognised value
`no result`	no result

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Identity Match`	First Name match result is `match` and Last Names match result is `match` and Date of Birth match result is not `mismatch` and Overall Address match result is `match`	The first name, last name, and address match. The date of birth doesn’t conflict with the record.
`Partial Identity Match`	First Name match result is `match` and Last Names match result is `match` and (Date of Birth match result is `match` or Overall Address match result is `partial match`)	The first and last names match, and either the date of birth matches or the address partially matches.
`Could Not Locate`	Supplier Decision is `unrecognised value`	The data source returned a decision that the module doesn’t recognise, so the module can’t locate the subject.
`Error`	An error occurs during processing	A system or data source error stopped the check from completing.
`Identity Mismatch`	Default, when no conditions matched	The subject’s details don’t meet the conditions for a full or partial identity match.

​Capabilities

​Generic email match result

​Input address quality level

​Date of birth match result

​Administrative area match result

​Initial matches

​Postal code match result

​Address line 1 match flag

​Last names match result

​Overall address match result

​Locality match result

​Generic phone match result

​First name match result

​Default outcomes

​Input payload

​Sample response

​Capabilities

​Number of matching sources

​Name + Address matches

​Name + DOB matches

​Name + DOB + Address matches

​ID + Name + Address matches

​ID + Name + DOB matches

​ID + Name + DOB + Address matches

​Is under 18

​GBG score

​Default outcomes

​Input payload

​Sample response

​Capabilities

​Input address quality level

​Supplier decision

​Count of matches against name and date of birth

​Count of matches against name, address and date of birth

​Total sources where name and either address or date of birth match

​Count of matches against document and name

​Count of matches against document, name, address and date of birth

​Count of matches against name and address

​Count of matches against document, name and date of birth

​Total sources where name and address match

​Total sources where name and address and date of birth match

​Total sources with more than one field match

​Count of matches against document, name and address

​Total sources where name and date of birth match

​Default outcomes

​Input payload

​Sample response

​Capabilities

​Generic email match result

​Input address quality level

​Date of birth match result

​Administrative area match result

​Initial matches

​Postal code match result

​Address line 1 match flag

​Last names match result

​Overall address match result

​Locality match result

​Generic phone match result

​First name match result

​Default outcomes

​Input payload

​Sample response

​Capabilities

​Supplier decision

​Default outcomes

​Input payload

​Sample response

​Capabilities

​Default outcomes

​Input payload

​Sample response

​Capabilities

​Input address quality level

​Supplier decision

​Default outcomes

​Input payload

​Sample response

​Capabilities

​Default outcomes

Capabilities

Generic email match result

Input address quality level

Date of birth match result

Administrative area match result

Initial matches

Postal code match result

Address line 1 match flag

Last names match result

Overall address match result

Locality match result

Generic phone match result

First name match result

Default outcomes

Input payload

Sample response

Capabilities

Number of matching sources

Name + Address matches

Name + DOB matches

Name + DOB + Address matches

ID + Name + Address matches

ID + Name + DOB matches

ID + Name + DOB + Address matches

Is under 18

GBG score

Default outcomes

Input payload

Sample response

Capabilities

Input address quality level

Supplier decision

Count of matches against name and date of birth

Count of matches against name, address and date of birth

Total sources where name and either address or date of birth match

Count of matches against document and name

Count of matches against document, name, address and date of birth

Count of matches against name and address

Count of matches against document, name and date of birth

Total sources where name and address match

Total sources where name and address and date of birth match

Total sources with more than one field match

Count of matches against document, name and address

Total sources where name and date of birth match

Default outcomes

Input payload

Sample response

Capabilities

Generic email match result

Input address quality level

Date of birth match result

Administrative area match result

Initial matches

Postal code match result

Address line 1 match flag

Last names match result

Overall address match result

Locality match result

Generic phone match result

First name match result

Default outcomes

Input payload

Sample response

Capabilities

Supplier decision

Default outcomes

Input payload

Sample response

Capabilities

Default outcomes

Input payload

Sample response

Capabilities

Input address quality level

Supplier decision

Default outcomes

Input payload

Sample response

Capabilities

Default outcomes