> ## Documentation Index
> Fetch the complete documentation index at: https://docs.go.gbgplc.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Data Verification
The Data Verification module verifies a subject's identity by cross-referencing submitted personal information, such as name, date of birth, address, and national ID numbers against trusted consumer, government, and credit bureau databases.
It counts how many independent data sources confirm different combinations of identity elements, allowing organisations to assess the strength and confidence of an identity match. This module is commonly used for KYC (Know Your Customer), AML (Anti-Money Laundering), and general identity verification across multiple countries.
This page contains documentation for the Data Verification - Single Match (All Sources) module, including its variants, capabilities, and the specific result codes it returns.
This variant 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.
Replace `your-journey-resourceID@latest` with your journey's resource ID. You can find this in the Journey Builder after publishing your journey.
```json JSON theme={null}
{
"resourceId": "your-journey-resourceID@latest",
"context": {
"subject": {
"uid": "Test Case 0391-003",
"identity": {
"firstName": "Juan",
"lastNames": ["Doe"],
"dateOfBirth": "1999-04-19",
"gender": "male",
"currentAddress": {
"country": "ARG",
"postalCode": "1824",
"locality": "CIUDAD AUTONOMA DE BUENOS AIRES",
"thoroughfare": "SUPERI 1405",
"building": "5 B",
"administrativeArea": "CIUDAD AUTONOMA DE BUENOS AIRES"
},
"phones": [
{
"type": "Landline",
"number": "35765588"
}
]
},
"documents": [
{
"type": "DNI Number",
"number": "33575465",
"country": "ARG"
},
{
"type": "Tax Identification Number",
"number": "20335754655",
"country": "ARG"
}
]
}
}
}
```
## Sample response
The following is a sample response showing a successful identity match.
```json theme={null}
{
"result": {
"inner": [],
"advice": {
"nameAddress": 1,
"nameDob": 1,
"nameDobAddress": 1,
"idNameAddress": 1,
"idNameDob": 1,
"idNameAddressDob": 1,
"idName": 1,
"sources": 1,
"isUnder18": false,
"phoneMatch": false,
"customDecision": null,
"gbgScore": 500
},
"status": "complete",
"outcome": "Match"
}
}
```
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`.
This variant verifies Australian subjects against trusted credit data sources. It uses the supplier decision capability with support for partial matches.
| 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. |
## 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 JSON theme={null}
{
"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 JSON theme={null}
{
"outcome": "Identity Match",
"advice": {}
}
```
This variant verifies Australian subjects against trusted directors register data sources.
| 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. |
## 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 JSON theme={null}
{
"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 JSON theme={null}
{
"outcome": "Identity Match",
"advice": {}
}
```
This variant verifies Australian subjects against historical electoral roll data (pre-2004). It has the most complex partial match logic of any variant, with seven distinct conditions that qualify as a partial match.
| 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. |
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 JSON theme={null}
{
"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 JSON theme={null}
{
"outcome": "Identity Match",
"advice": {}
}
```
This variant verifies Australian subjects against trusted population data sources.
| 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. |
## 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 JSON theme={null}
{
"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 JSON theme={null}
{
"outcome": "Identity Match",
"advice": {}
}
```
This variant orchestrates identity verification across multiple Australian government ID 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. |
## 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.
Replace `your-journey-resourceID@latest` with your journey's resource ID. You can find this in the Journey Builder after publishing your journey.
```json JSON theme={null}
{
"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 JSON theme={null}
{
"outcome": "Refer",
"advice": {
"overallVerificationStatus": "IN_PROGRESS"
}
}
```
This variant verifies Australian subjects against standard sources for AML-regulated customers. It adds a credit bureau check capability alongside the overall verification status.
| 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. |
## 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.
Replace `your-journey-resourceID@latest` with your journey's resource ID. You can find this in the Journey Builder after publishing your journey.
```json JSON theme={null}
{
"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 for a successful identity verification.
```json JSON theme={null}
{
"outcome": "Pass",
"advice": {
"sourcesUsed": {
"NAD": "VERIFIED",
"Data Co-op": "VERIFIED",
"PND": "VERIFIED",
"GDC Asic Person Name": "VERIFIED",
"GDC Tenancy File": "VERIFIED",
"AU EMD": "VERIFIED",
"Credit History": "VERIFIED"
},
"illionStatus": "VERIFIED",
"overallVerificationStatus": "VERIFIED"
},
"export": {
"sku": [
"greenID_AU_NZ_govID_platformcharge",
"greenID_AU_AML"
]
}
}
```
This variant verifies Australian subjects against standard sources for non-AML customers. It provides only the overall verification status capability without a credit bureau check.
| 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).
## 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 JSON theme={null}
{
"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 for a successful identity verification.
```json JSON theme={null}
{
"outcome": "Pass",
"advice": {
"sourcesUsed": {
"NAD": "AUTOFAIL",
"Data Co-op": "AUTOFAIL",
"PND": "AUTOFAIL",
"GDC Asic Person Name": "AUTOFAIL",
"GDC Tenancy File": "AUTOFAIL",
"AU EMD": "AUTOFAIL",
"PayrollData": "VERIFIED",
"SuperannuationData": "AUTOFAIL"
},
"overallVerificationStatus": "VERIFIED"
},
"export": {
"sku": [
"greenID_AU_NZ_govID_platformcharge",
"greenID_AU_nonAML",
"greenID_AU_superpayroll"
]
}
}
```
This variant extends the AML standard sources variant with additional data sources.
| 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)](#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.
Replace `your-journey-resourceID@latest` with your journey's resource ID. You can find this in the Journey Builder after publishing your journey.
```json JSON theme={null}
{
"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 JSON theme={null}
{
"outcome": "Refer",
"advice": {
"sourcesUsed": {
"NAD": "AUTOFAIL",
"Data Co-op": "AUTOFAIL",
"PND": "AUTOFAIL",
"GDC Asic Person Name": "AUTOFAIL",
"GDC Tenancy File": "AUTOFAIL",
"AU EMD": "AUTOFAIL",
"Credit History": "AUTOFAIL",
"PayrollData": "AUTOFAIL",
"SuperannuationData": "AUTOFAIL",
"AUBureauHeader": "AUTOFAIL"
},
"illionStatus": "AUTOFAIL",
"experianStatus": "AUTOFAIL",
"overallVerificationStatus": "IN_PROGRESS"
},
"export": {
"sku": [
"greenID_AU_NZ_govID_platformcharge",
"greenID_AU_AML",
"greenID_AU_superpayroll",
"greenID_AU_experian"
]
}
}
```
This variant provides the same standard-plus-additional-sources verification for non-AML customers. It does not include a credit bureau check capability.
| 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.
## 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 JSON theme={null}
{
"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 for a successful identity verification.
```json JSON theme={null}
{
"outcome": "Pass",
"advice": {
"sourcesUsed": {
"NAD": "AUTOFAIL",
"Data Co-op": "AUTOFAIL",
"PND": "AUTOFAIL",
"GDC Asic Person Name": "AUTOFAIL",
"GDC Tenancy File": "AUTOFAIL",
"AU EMD": "AUTOFAIL",
"PayrollData": "VERIFIED",
"SuperannuationData": "AUTOFAIL"
},
"overallVerificationStatus": "VERIFIED"
},
"export": {
"sku": [
"greenID_AU_NZ_govID_platformcharge",
"greenID_AU_nonAML",
"greenID_AU_superpayroll"
]
}
}
```
This variant verifies Australian subjects against trusted tenancy data sources.
| 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. |
## 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 JSON theme={null}
{
"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 JSON theme={null}
{
"outcome": "Identity Match",
"advice": {}
}
```
This variant performs a single-source identity verification check for Brazilian subjects with a required CPF (Cadastro de Pessoas Físicas) 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](#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.
Replace `your-journey-resourceID@latest` with your journey's resource ID. You can find this in the Journey Builder after publishing your journey.
```json JSON theme={null}
{
"resourceId": "your-journey-resourceID@latest",
"context": {
"subject": {
"uid": "Test Case 0390-003",
"identity": {
"currentAddress": {
"country": "BRA",
"postalCode": "21760620",
"locality": "Rio de Janeiro",
"thoroughfare": "Travessa Helena",
"building": "792",
"administrativeArea": "RJ"
},
"dateOfBirth": "1975-03-23",
"firstName": "Adalberto",
"lastNames": ["Costa Silva"],
"phones": [
{
"type": "Mobile",
"number": "11345678901"
},
{
"type": "Landline",
"number": "1182259490"
}
]
},
"documents": [
{
"type": "CPF Number",
"number": "87565779318",
"country": "BRA"
}
]
}
}
}
```
## Sample response
The following is a sample response showing a successful identity match.
```json JSON theme={null}
{
"advice": {
"contains": {
"nameAddress": 1,
"nameDob": 1,
"nameDobAddress": 1,
"idNameAddress": 1,
"idNameDob": 1,
"idNameAddressDob": 1,
"idName": 1,
"sources": 1,
"isUnder18": false,
"customDecision": null,
"gbgScore": 514
}
},
"outcome": "Match"
}
```
This variant performs a single-source check 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](#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.
Replace `your-journey-resourceID@latest` with your journey's resource ID. You can find this in the Journey Builder after publishing your journey.
```json JSON theme={null}
{
"resourceId": "your-journey-resourceID@latest",
"context": {
"subject": {
"identity": {
"dateOfBirth": "1987-08-08",
"firstName": "ADALGISA",
"lastNames": ["Nery"],
"currentAddress": {
"country": "BRA",
"postalCode": "14780490",
"locality": "BARRETOS",
"thoroughfare": "BARRETOS",
"building": "AV 55"
}
}
}
}
}
```
## Sample response
The following is a sample response showing a successful identity match.
```json JSON theme={null}
{
"advice": {
"contains": {
"nameAddress": 3,
"nameDob": 3,
"nameDobAddress": 3,
"idNameAddress": 0,
"idNameDob": 0,
"idNameAddressDob": 0,
"idName": 0,
"sources": 3,
"isUnder18": false,
"customDecision": null,
"gbgScore": 1000
}
},
"outcome": "Match"
}
```
This variant performs a standard identity verification check for Canadian subjects without FINTRAC-specific compliance requirements. It uses the simpler source-count capability structure rather than the field-level match flags used by the Fintrac Single Bureau variants. It 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](#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.
Replace `your-journey-resourceID@latest` with your journey's resource ID. You can find this in the Journey Builder after publishing your journey.
```json JSON theme={null}
{
"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 JSON theme={null}
{
"advice": {
"contains": {
"nameAddress": 1,
"nameDob": 1,
"nameDobAddress": 1,
"idNameAddress": 0,
"idNameDob": 0,
"idNameAddressDob": 0,
"idName": 0,
"sources": 1,
"isUnder18": false,
"customDecision": null,
"gbgScore": 500
}
},
"outcome": "Match"
}
```
For a full explanation of match flag values, see [match flags](/docs/go-v1/get-started/glossary#match-flags) in the glossary.
This variant performs a single-source identity verification check for Chilean subjects using their identity card number (Cédula 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](#argentina-single-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 JSON theme={null}
{
"resourceId": "your-journey-resourceID@latest",
"context": {
"subject": {
"identity": {
"firstName": "GASPAR",
"dateOfBirth": "1984-12-24",
"currentAddress": {
"building": "678",
"thoroughfare": "V MACKENNY",
"locality": "La Florida",
"postalCode": "",
"country": "CHL"
},
"lastNames": ["SOTO"]
},
"documents": [
{
"type": "Identity Card",
"number": "120067849",
"country": "CHL"
}
]
}
}
}
```
## Sample response
The following is a sample response for a successful identity match.
```json JSON theme={null}
{
"advice": {
"contains": {
"nameAddress": 1,
"nameDob": 1,
"nameDobAddress": 1,
"idNameAddress": 1,
"idNameDob": 1,
"idNameAddressDob": 1,
"idName": 1,
"sources": 1,
"isUnder18": false,
"customDecision": null,
"gbgScore": 500
}
},
"outcome": "Match"
}
```
This variant performs a single-source identity verification check for Colombian subjects using their identity card number (Cédula de Ciudadanía).
| 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](#argentina-single-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 JSON theme={null}
{
"resourceId": "your-journey-resourceID@latest",
"context": {
"subject": {
"identity": {
"currentAddress": {
"locality": "Tabatinga",
"thoroughfare": "ABC STREET",
"building": "1",
"administrativeArea": "AMAZONAS",
"country": "COL"
},
"dateOfBirth": "1975-09-17",
"firstName": "SAMUEL",
"lastNames": ["RODRIGUEZ"]
},
"documents": [
{
"type": "Identity Card",
"number": "14502642",
"country": "COL"
}
]
}
}
}
```
## Sample response
The following is a sample response for a partial identity match.
```json JSON theme={null}
{
"advice": {
"contains": {
"nameAddress": 0,
"nameDob": 1,
"nameDobAddress": 0,
"idNameAddress": 0,
"idNameDob": 0,
"idNameAddressDob": 0,
"idName": 0,
"sources": 1,
"isUnder18": false,
"customDecision": null,
"gbgScore": 250
}
},
"outcome": "Partial 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](#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. |
This variant performs a single-source identity verification check for French subjects. Notably, a landline phone number is a required input. This is unique among Data Verification variants and reflects the data sources available for French identity verification.
| Detail | Value |
| --------------- | ------------------------------------------ |
| Required inputs | Full name, current address, landline phone |
| Optional inputs | Date of birth |
The capabilities are the same as [Argentina: Single match](#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. |
This variant verifies German subjects against Schufa, Germany's leading credit bureau that holds credit and identity data on the majority of German adults. Unlike the other German variants, this one uses field-level match flags rather than source counts, providing granular detail on 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. |
For a full explanation of match flag values, see [match flags](/docs/go-v1/get-started/glossary#match-flags) in the glossary.
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](#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. |
This variant verifies Italian subjects against trusted citizen data sources. It shares the same capability structure and default outcome logic as [Spain: Citizen Source](#spain-citizen-source).
| Detail | Value |
| --------------- | --------------------------------------------------------------------------- |
| Required inputs | Full name, current address (with country code), date of birth, phone, email |
| Optional inputs | None |
This variant performs a single-source check for Italian subjects without requiring a Codice Fiscale.
| Detail | Value |
| --------------- | ---------------------------------------------------------------------------------- |
| Required inputs | Full name, current address |
| Optional inputs | Date of birth, identity card, landline phone, mobile phone, place of birth, gender |
The capabilities are the same as [Argentina: Single match](#argentina-single-match).
This variant performs a single-source identity verification check for Italian subjects using their Codice Fiscale (Italian tax identification code). The Codice Fiscale is a unique alphanumeric code assigned to every Italian citizen and resident, derived from their name, date of birth, gender, and birthplace.
| Detail | Value |
| --------------- | ------------------------------------------------------------------- |
| Required inputs | Full name, current address, identity card (Codice Fiscale) |
| Optional inputs | Date of birth, landline phone, mobile phone, place of birth, gender |
The capabilities are the same as [Argentina: Single match](#argentina-single-match).
This variant performs a single-source identity verification check for Mexican subjects using their CURP (Clave Única de Registro de Población) via the tax identification number and identity card inputs.
| Detail | Value |
| --------------- | ---------------------------------------------------------------- |
| Required inputs | Full name, tax identification number (RFC), identity card (CURP) |
| Optional inputs | Date of birth, current address, gender |
The capabilities are the same as [Argentina: Single match](#argentina-single-match).
This variant verifies Dutch subjects against trusted citizen data sources. It shares the same capability structure and default outcome logic as [Spain: Citizen Source](#spain-citizen-source).
| Detail | Value |
| --------------- | --------------------------------------------------------------------------- |
| Required inputs | Full name, current address (with country code), date of birth, phone, email |
| Optional inputs | None |
This variant performs a single-source identity verification check for Dutch subjects against consumer data sources. It extends the standard source-count capabilities with phone and email match indicators.
| Detail | Value |
| --------------- | ----------------------------------- |
| Required inputs | Determined by journey configuration |
| Optional inputs | None |
## Capabilities
This variant returns all the same source-count capabilities as [Argentina: Single match](#argentina-single-match), plus two additional boolean capabilities:
## Phone match
Indicates whether one or more of the subject's submitted phone numbers matched a phone number on file in the data source.
| Value | Description |
| ------- | -------------------------------------------------------------------------------------- |
| `true` | One or more phone numbers matched. |
| `false` | No phone numbers matched, or no phone number was submitted. This is the default value. |
## Email match
Indicates whether one or more of the subject's submitted email addresses matched an email address on file in the data source.
| Value | Description |
| ------- | --------------------------------------------------------------------------------- |
| `true` | One or more email addresses matched. |
| `false` | No email addresses matched, or no email was submitted. This is the default value. |
## 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. |
This variant performs a single-source identity verification check for Dutch subjects against identity-specific data sources. It extends the standard capabilities with a phone match indicator (but not email match, unlike the consumer variant).
| Detail | Value |
| --------------- | ----------------------------------- |
| Required inputs | Determined by journey configuration |
| Optional inputs | None |
The capabilities are the same as [Argentina: Single match](#argentina-single-match), plus the [Phone match](#phone-match) capability documented under the Netherlands consumer variant. The default outcomes are the same as [Netherlands: Single match consumer](#netherlands-single-match-consumer).
This variant verifies New Zealand subjects against trusted birth certificate data sources with mandatory GovID inclusion. It returns only the supplier decision, with no individual field match flags. Capabilities and default outcomes are the same as [New Zealand: Citizenship Certificate (mandatory GovID)](#new-zealand-citizenship-certificate-mandatory-govid).
| Detail | Value |
| --------------- | ------------------------ |
| Required inputs | Full name, date of birth |
| Optional inputs | None |
## Input payload
The following is a sample payload used to submit identity data to the Data Verification module for processing.
```json JSON theme={null}
{
"resourceId": "your-journey-resourceID@latest",
"context": {
"subject": {
"identity": {
"firstName": "Jane",
"middleNames": ["Marie"],
"lastNames": ["Doe"],
"dateOfBirth": "1990-05-15",
"currentAddress": {
"premise": "10",
"thoroughfare": "Queen Street",
"locality": "Auckland",
"postalCode": "1010",
"country": "NZL"
},
"phones": [
{
"type": "mobile",
"number": "+6421000000"
}
]
},
"accounts": [
{
"type": "bank",
"accountNumber": "0012345678",
"sortCode": "01-0001"
}
],
"documents": [
{
"type": "birth_certificate",
"number": "2020/12345"
}
]
}
}
}
```
Replace `your-journey-resourceID@latest` with your journey's resource ID. You can find this in the Journey Builder after publishing your journey.
## Sample response
The following is a sample response for a successful identity match.
```json JSON theme={null}
{
"outcome": "Identity Match",
"advice": {}
}
```
For a full explanation of match flag values, see [match flags](/docs/go-v1/get-started/glossary#match-flags) in the glossary.
This variant verifies New Zealand subjects against trusted birth certificate data sources. This variant does not include GovID in the matching process.
| 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 |
| -------------------------------- | ------------------------------------- | ---------------------------------------------- |
| First name match result | `match`, `not available` | Match result for the subject's first name. |
| Middle names match result | `match`, `not available`, `no result` | Match result for the subject's middle name(s). |
| Last names match result | `match`, `not available` | Match result for the subject's last name. |
| Date of birth match result | `match`, `not available` | Match result for the subject's date of birth. |
| Supplied DOB below age threshold | `Y`, `N` | Indicates whether the subject is under 18. |
| 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 |
| ------------------- | --------------------------------------- | ------------------------------------ |
| `Alert` | Supplied DOB below age threshold is `Y` | The subject is under 18. |
| `Identity Match` | Supplier decision is `match` | Birth certificate details confirmed. |
| `Identity Mismatch` | Default (no conditions matched) | The subject could not be verified. |
This variant verifies New Zealand subjects against trusted citizenship certificate data sources with mandatory GovID inclusion in the matching process. It is the most streamlined NZ variant. It returns only the supplier decision, with no individual field match flags.
| Detail | Value |
| --------------- | ------------------------------------------------------ |
| Required inputs | Full name, date of birth, identity card (GovID number) |
| 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. No individual field match flags are returned. The supplier makes a single pass/fail determination including the GovID number. |
## Default outcomes
The table below lists the default outcomes for this variant.
| Outcome | Condition | Description |
| ------------------- | ------------------------------- | ---------------------------------------------------------- |
| `Identity Match` | Supplier decision is `match` | Citizenship certificate details confirmed including GovID. |
| `Identity Mismatch` | Default (no conditions matched) | The subject could not be verified. |
For a full explanation of match flag values, see [match flags](/docs/go-v1/get-started/glossary#match-flags) in the glossary.
This variant verifies New Zealand subjects against trusted citizenship certificate data sources. This variant does not include GovID in the matching process.
| Detail | Value |
| --------------- | ------------------------ |
| Required inputs | Full name, date of birth |
| Optional inputs | None |
Capabilities and default outcomes are the same as [New Zealand: Birth Certificate (without GovID)](#new-zealand-birth-certificate-without-govid).
This variant verifies New Zealand subjects against credit header data. Unlike Credit Header 2 (which uses a supplier decision with partial match support), Credit Header 1 uses individual field-level match flags and constructs the outcome logic from those flags directly. It matches on full name (as a single field), date of birth, and address.
| 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 |
| ---------------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Full name match result | `match`, `mismatch`, `no result` | Match result for the subject's full name (matched as a single combined field rather than individual name components). |
| Date of birth match result | `match`, `mismatch`, `no result` | Match result for the subject's date of birth. |
| Overall address match result | `match`, `mismatch`, `no result` | Overall address match result. |
| Supplier decision | `match`, `mismatch`, `partial match`, `no result` | The credit bureau's overall match decision. This capability is available for custom evaluation rules but is not used in the default outcome logic — the defaults are driven by the individual field flags instead. |
| Input address quality level | `1` (excellent), `2` (good), `3` (poor), `4` (not possible to validate) | Quality of the submitted address. |
## Default outcomes
The table below lists the default outcomes for this variant.
| Outcome | Condition | Description |
| ------------------------ | --------------------------------------------------------------- | ------------------------------------------------------------- |
| `Identity Match` | Full name is `match` and address is `match` and DOB is `match` | All three elements fully matched. |
| `Partial Identity Match` | Full name is `match` and (address is `match` or DOB is `match`) | Name confirmed plus either address or DOB, but not all three. |
| `Identity Mismatch` | Default (no conditions matched) | The subject could not be verified. |
This variant verifies New Zealand subjects against trusted credit data sources. Unlike most other NZ variants, this one supports a `Partial Identity Match` outcome when the supplier returns a partial match.
| 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 |
| -------------------------------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| Full name match result | `match`, `mismatch`, `no result` | Match result for the subject's full name (matched as a single field rather than individual name components). |
| Date of birth match result | `match`, `mismatch`, `no result` | Match result for the subject's date of birth. |
| Overall address match result | `match`, `mismatch`, `no result` | Overall address match result. |
| Input address quality level | `1` (excellent), `2` (good), `3` (poor), `4` (not possible to validate) | Quality of the submitted address. |
| Supplied DOB below age threshold | `Y`, `N` | Indicates whether the subject is under 18. |
| Supplier decision | `match`, `mismatch`, `partial match`, `no result` | The data source's overall match decision. This variant uniquely supports `partial match` as a supplier decision value. |
## Default outcomes
The table below lists the default outcomes for this variant.
| Outcome | Condition | Description |
| ------------------------ | --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `Alert` | Supplied DOB below age threshold is `Y` | The subject is under 18. |
| `Identity Match` | Supplier decision is `match` | Full match confirmed. |
| `Partial Identity Match` | Supplier decision is `partial match` | Some identity elements matched but not all. The journey may route to manual review or request additional verification. |
| `Identity Mismatch` | Default (no conditions matched) | The subject could not be verified. |
This variant verifies New Zealand subjects against a third NZ credit reporting agency. It provides the most granular capability set of any NZ credit header variant, with individual name component match flags, address component match flags, and a deceased flag.
| Detail | Value |
| --------------- | ----------------------------------------- |
| Required inputs | Full name, current address, date of birth |
| 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, middle, and last names.
| Capability | Values | Description |
| ------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------- |
| First name match result | `match`, `mismatch`, `partial match`, `not available`, `unrecognised value`, `no result` | Match result for the subject's first name. |
| Middle names match result | Same values | Match result for the subject's middle name(s). |
| Last names match result | Same values | 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 |
| ------------------------------- | ---------------------------------------------------------------------------------------- | --------------------------------------------- |
| Overall address match result | `match`, `mismatch`, `partial match`, `not available`, `unrecognised value`, `no result` | Overall address match result. |
| Premise match result | Same values | Match result for the property number. |
| Thoroughfare match result | Same values | Match result for the street name. |
| Locality match result | Same values | Match result for the city or town. |
| Dependent locality match result | `match`, `mismatch`, `not available`, `unrecognised value`, `no result`, `partial match` | Match result for the suburb or neighbourhood. |
### Other match flags
Date of birth, deceased flag, and address quality.
| Capability | Values | Description |
| --------------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------ |
| Date of birth match result | `match`, `mismatch`, `unrecognised value`, `no result` | Match result for the subject's date of birth. |
| Deceased flag | `Y`, `N`, `no result` | Indicates whether the subject is recorded as deceased. |
| Input address quality level | `1` (excellent), `2` (good), `3` (poor), `4` (not possible to validate) | Quality of the submitted address. |
## Default outcomes
The table below lists the default outcomes for this variant.
| Outcome | Condition | Description |
| ------------------------ | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| `Alert` | Deceased flag is `Y` | The subject is recorded as deceased. |
| `Identity Match` | Last name is `match` and first name is `match` and DOB is `match` and address is `match` | All four elements fully matched. |
| `Partial Identity Match` | Last name is `match` and first name is `match` and (DOB is `match` or address is `match`) | Name confirmed plus either DOB or address, but not all four. |
| `Identity Mismatch` | Default (no conditions matched) | The subject could not be verified. |
This variant verifies New Zealand subjects against trusted directors and shareholders data sources. It matches name and address at the individual component level (premise, thoroughfare, locality, postal code), providing more granular address verification than other NZ variants.
| Detail | Value |
| --------------- | -------------------------- |
| Required inputs | Full name, current address |
| Optional inputs | None |
## Capabilities
The capabilities returned by this variant are grouped into name and address component match flags.
### Name match flags
Match results for the subject's first, middle, and last names.
| Capability | Values | Description |
| ------------------------- | -------------------------------- | ---------------------------------------------- |
| First name match result | `match`, `mismatch`, `no result` | Match result for the subject's first name. |
| Middle names match result | `match`, `mismatch`, `no result` | Match result for the subject's middle name(s). |
| Last names match result | `match`, `mismatch`, `no result` | Match result for the subject's last name. |
### Address component match flags
Granular match results for individual address components.
| Capability | Values | Description |
| ------------------------------- | -------------------------------- | -------------------------------------------------------- |
| Premise match result | `match`, `mismatch`, `no result` | Match result for the property number. |
| Sub building match result | `match`, `mismatch`, `no result` | Match result for the sub-building (flat or unit number). |
| Thoroughfare match result | `match`, `mismatch`, `no result` | Match result for the street name. |
| Locality match result | `match`, `mismatch`, `no result` | Match result for the city or town. |
| Dependent locality match result | `match`, `mismatch`, `no result` | Match result for the suburb or neighbourhood. |
| Postal code match result | `match`, `mismatch`, `no result` | Match result for the postal code. |
## Default outcomes
The table below lists the default outcomes for this variant.
| Outcome | Condition | Description |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Identity Match` | First name is `match` and last names is `match` and premise is `match` and thoroughfare is `match` and postal code is `match` and (dependent locality is `match` or locality is `match`) | Full match. Name confirmed and address verified at the component level. Both the dependent locality and locality are accepted for the location component, because NZ addresses might use either. |
| `Identity Mismatch` | Default (no conditions matched) | The subject could not be verified. |
For a full explanation of match flag values, see [match flags](/docs/go-v1/get-started/glossary#match-flags) in the glossary.
This variant verifies New Zealand subjects against trusted driver licence data sources in real time. It verifies the licence number, version number, name, and date of birth.
| Detail | Value |
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Required inputs | Full name, date of birth, driving licence document (licence number and version number). The `type` field must be set to `Driving Licence`; the check fails if it is missing. |
| Optional inputs | None |
## Capabilities
This variant returns the same name match flags as [New Zealand: Land Titles](#new-zealand-land-titles), plus:
| Capability | Values | Description |
| ------------------------------------ | ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| Date of birth match result | `match`, `not available`, `no result` | Match result for the subject's date of birth. |
| Driving licence number match result | `match`, `not available`, `no result` | Match result for the submitted licence number against the government record. |
| Document version number match result | `match`, `not available`, `no result` | Match result for the licence card version number. NZ driver licences have a version number that changes each time the card is renewed or replaced. |
| Supplied DOB below age threshold | `Y`, `N` | Indicates whether the subject is under 18. |
| 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 |
| ------------------- | --------------------------------------- | ------------------------------------------------- |
| `Alert` | Supplied DOB below age threshold is `Y` | The subject is under 18. |
| `Identity Match` | Supplier decision is `match` | The data source confirmed the subject's identity. |
| `Identity Mismatch` | Default (no conditions matched) | The subject could not be verified. |
## Input payload
The following is a sample payload used to submit identity data to the Data Verification module for processing.
```json JSON theme={null}
{
"resourceId": "your-journey-resourceID@latest",
"context": {
"subject": {
"identity": {
"firstName": "James",
"middleNames": ["William"],
"lastNames": ["Walker"],
"dateOfBirth": "1990-03-15",
"currentAddress": {
"premise": "12B",
"thoroughfare": "Queen Street",
"locality": "Auckland",
"postalCode": "1010",
"country": "NZL"
}
},
"documents": [
{
"type": "Driving Licence",
"number": "NZ111111",
"cardNumber": "111"
}
]
}
}
}
```
The table below describes each field in the payload, including validation rules for driver licence document fields.
| Field | Required | Description |
| ------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `identity.firstName` | Yes | First name of the subject. |
| `identity.middleNames` | No | Array containing middle name(s) of the subject. |
| `identity.lastNames` | Yes | Array containing the last name(s) of the subject. |
| `identity.dateOfBirth` | Yes | Date of birth in `YYYY-MM-DD` format. |
| `identity.currentAddress` | No | Current address of the subject, broken down into `premise`, `thoroughfare`, `locality`, `postalCode`, and `country` (ISO 3166-1 alpha-3). |
| `documents[].type` | Yes | Document type. Must be set to `"Driving Licence"`; the check fails if this field is missing. |
| `documents[].number` | Yes | Driver licence number. Must match the pattern `^[A-Za-z]{1,2}[0-9]{6}$` (1–2 letters followed by 6 digits). Example: `"AB123456"`. |
| `documents[].cardNumber` | Yes | Card version number printed on the driver licence. Must match the pattern `^[0-9]{3}$` (exactly 3 digits). Example: `"123"`. |
## Sample response
The following is a sample response for a successful identity match.
```json JSON theme={null}
{
"outcome": "Identity Match",
"advice": {}
}
```
For a full explanation of match flag values, see [match flags](/docs/go-v1/get-started/glossary#match-flags) in the glossary.
This variant verifies New Zealand subjects against trusted land ownership data sources. It uses field-level match flags with a supplier decision capability that provides the data source's overall match assessment.
| Detail | Value |
| --------------- | -------------------------- |
| Required inputs | Full name, current address |
| Optional inputs | None |
## Capabilities
The capabilities returned by this variant are grouped into name match flags, an address match flag, address quality, and supplier decision.
### Name match flags
Match results for the subject's first, middle, and last names against the Land Titles record.
| Capability | Values | Description |
| ------------------------- | ------------------------------------- | ------------------------------------------------------------------------- |
| First name match result | `match`, `not available`, `no result` | Match result for the subject's first name against the Land Titles record. |
| Middle names match result | `match`, `not available`, `no result` | Match result for the subject's middle name(s). |
| Last names match result | `match`, `not available`, `no result` | Match result for the subject's last name. |
### Address match flag
Overall address match result.
| Capability | Values | Description |
| ---------------------------- | ------------------------------------- | ----------------------------- |
| Overall address match result | `match`, `not available`, `no result` | Overall address match result. |
### Address quality
Indicator of how well the submitted address could be validated.
| Capability | Values | Description |
| --------------------------- | ----------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Input address quality level | `1` (excellent), `2` (good), `3` (poor), `4` (not possible to validate) | A broad indicator of the quality of the submitted address. A value of `4` (the default) indicates the address could not be validated. This capability can be used in custom evaluation rules to filter out results where the address input was too poor to produce a meaningful match. |
### Supplier decision
Overall match decision returned by the data source. This is the primary capability used in the default outcome logic.
| Capability | Values | Description |
| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| Supplier decision | `match`, `mismatch`, `unrecognised value`, `not available`, `no result` | The data source's overall match decision. This is the primary capability used in the default outcome logic. |
## Default outcomes
The table below lists the default outcomes for this variant.
| Outcome | Condition | Description |
| ------------------- | ------------------------------- | ------------------------------------------------- |
| `Identity Match` | Supplier decision is `match` | The data source confirmed the subject's identity. |
| `Identity Mismatch` | Default (no conditions matched) | The subject could not be verified. |
For a full explanation of match flag values, see [match flags](/docs/go-v1/get-started/glossary#match-flags) in the glossary.
This variant verifies New Zealand subjects against trusted passport data sources. It verifies the passport number, expiry date, name, and date of birth.
| Detail | Value |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Required inputs | Full name, current address, date of birth, passport document (passport number and expiry date). The `type` field must be set to `Passport`; the check fails if it is missing. |
| Optional inputs | None |
## Capabilities
This variant returns the same name and DOB match flags as [New Zealand: Birth Certificate (without GovID)](#new-zealand-birth-certificate-without-govid), plus:
| Capability | Values | Description |
| -------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Passport number match result | `match`, `not available`, `no result` | Match result for the submitted passport number. |
| Passport expiry match result | `match`, `not available`, `no result` | Match result for the passport expiry date. A `match` confirms the submitted expiry date matches the record, which also implicitly confirms the passport has not been replaced. |
| Supplied DOB below age threshold | `Y`, `N` | Indicates whether the subject is under 18. |
| 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 |
| ------------------- | --------------------------------------- | ---------------------------------- |
| `Alert` | Supplied DOB below age threshold is `Y` | The subject is under 18. |
| `Identity Match` | Supplier decision is `match` | Passport details confirmed. |
| `Identity Mismatch` | Default (no conditions matched) | The subject could not be verified. |
## Input payload
The following is a sample payload used to submit identity data to the Data Verification module for processing.
```json JSON theme={null}
{
"resourceId": "your-journey-resourceID@latest",
"context": {
"subject": {
"identity": {
"firstName": "James",
"middleNames": ["William"],
"lastNames": ["Walker"],
"dateOfBirth": "1990-03-15"
},
"documents": [
{
"type": "Passport",
"number": "AB123456",
"expiryDate": "2029-03-14"
}
]
}
}
}
```
The table below describes each field in the payload, including validation rules for passport document fields.
| Field | Required | Description |
| ------------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `identity.firstName` | Yes | First name of the subject. |
| `identity.middleNames` | No | Array containing middle name(s) of the subject. |
| `identity.lastNames` | Yes | Array containing the last name(s) of the subject. |
| `identity.dateOfBirth` | Yes | Date of birth in `YYYY-MM-DD` format. |
| `documents[].type` | Yes | Document type. Must be set to `"Passport"`; the check fails if this field is missing. |
| `documents[].number` | Yes | Passport number. Must match the pattern `^[A-Za-z]{1,2}[0-9]{6}$` (1–2 letters followed by 6 digits). Example: `"AB123456"`. |
| `documents[].expiryDate` | Yes | Passport expiry date in `YYYY-MM-DD` format. Example: `"2029-03-14"`. |
## Sample response
The following is a sample response for a successful identity match.
```json JSON theme={null}
{
"outcome": "Identity Match",
"advice": {}
}
```
For a full explanation of match flag values, see [match flags](/docs/go-v1/get-started/glossary#match-flags) in the glossary.
This variant orchestrates identity verification across multiple New Zealand government ID sources (driver licence, passport, citizenship certificate, and birth certificate). It manages the verification workflow across sources and reports an overall verification status.
| 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. `VERIFIED` indicates the verification rule has been met across the required sources. `IN_PROGRESS` indicates verification is not yet complete. Additional sources may still need to be checked. |
| DVS sources remaining | Enumset | `nztadriverslicence`, `nzpassport`, `nzcitizenship`, `nzbirthcertificate` | The government ID sources (Document Verification Service sources) that have not yet been checked. This capability is informational and is not used in the default outcome logic. |
## 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. The journey should route to additional verification steps or manual review. |
| `Error` | Default | An unexpected error occurred. |
This variant verifies identity against any standard New Zealand source (not limited to government sources). It provides a simpler capability set with only the overall verification status without a sources-remaining tracker.
| 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. `VERIFIED` indicates at least one standard source confirmed the subject's identity. `IN_PROGRESS` indicates verification is not yet complete. |
## Default outcomes
The table below lists the default outcomes for this variant.
| Outcome | Condition | Description |
| ------- | -------------------------------------------------- | ------------------------------------------------------- |
| `Pass` | Overall verification status includes `VERIFIED` | Identity verified against at least one standard source. |
| `Refer` | Overall verification status includes `IN_PROGRESS` | Verification is not yet complete. |
| `Error` | Default | An unexpected error occurred. |
This variant verifies New Zealand subjects against trusted tenancy data sources. Unlike the Australian Tenancy variant (which uses a simple supplier decision), this variant provides individual field-level match flags with a partial match outcome.
| 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` | 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`, `no result` | Match result for DOB. |
| Overall address match result | `match`, `mismatch`, `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 DOB is `match` and address is `match` | All four elements fully matched. |
| `Partial Identity Match` | First name is `match` and last name is `match` and (DOB is `match` or address is `match`) | Name confirmed plus either DOB or address, but not all four elements. |
| `Identity Mismatch` | Default | The subject could not be verified. |
For a full explanation of match flag values, see [match flags](/docs/go-v1/get-started/glossary#match-flags) in the glossary.
This variant performs a single-source identity verification check for Peruvian subjects. It extends the standard source-count capabilities with an ID + Name match counter (without requiring address or DOB alongside the ID) and a phone match indicator.
| Detail | Value |
| --------------- | ------------------------------------------------------------------------- |
| Required inputs | Full name, date of birth, identity card (DNI) |
| Optional inputs | Current address, mobile phone, work email, personal email, landline phone |
## Capabilities
This variant returns all the same source-count capabilities as [Argentina: Single match](#argentina-single-match), plus:
## ID + Name matches
The number of data sources where the subject's national ID number and name matched, without requiring address or DOB.
| Detail | Description |
| ------- | ----------- |
| Type | Integer |
| Range | 0–5 |
| Default | `0` |
This is a lower-confidence match than ID + Name + Address or ID + Name + DOB, but it confirms that the ID number is associated with the submitted name.
## Phone match
| Value | Description |
| ------- | ---------------------------------------------------- |
| `true` | One or more phone numbers matched. |
| `false` | No phone numbers matched. This is the default value. |
## 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. |
| `Partial Match` | Name + Address ≥ 1 or Name + DOB ≥ 1 or ID + Name ≥ 1 | Partial match. Note that ID + Name (without address or DOB) qualifies as a partial match for Peru. |
| `No Match` | Name + Address \< 1 | No match. |
| `Error` | Default | An unexpected error occurred. |
This variant performs a single-source check for Polish subjects.
| Detail | Value |
| --------------- | ----------------------------------- |
| Required inputs | Determined by journey configuration |
| Optional inputs | None |
The capabilities are the same as [Argentina: Single match](#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. |
This variant performs a single-source check for Polish subjects against population register data sources. Capabilities and default outcomes are the same as [Poland: Single match](#poland-single-match).
This variant performs a single-source identity verification check for South African subjects using their identity card number (South African ID number), a 13-digit number that encodes the subject's date of birth, gender, and citizenship status).
| Detail | Value |
| --------------- | -------------------------------------------------------------------- |
| Required inputs | Full name, identity card number |
| Optional inputs | Current address, date of birth, landline phone, mobile phone, gender |
The capabilities are the same as [Argentina: Single match](#argentina-single-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 JSON theme={null}
{
"resourceId": "your-journey-resourceID@latest",
"context": {
"subject": {
"identity": {
"currentAddress": {
"country": "ZAF",
"postalCode": "6665",
"locality": "Cape Town",
"thoroughfare": "Lily Road",
"building": "45",
"administrativeArea": "JOHANNESBURG"
},
"dateOfBirth": "1992-02-20",
"firstName": "Ann",
"lastNames": ["Gently"],
"phones": [
{
"type": "Mobile",
"number": "03487956422"
}
]
},
"documents": [
{
"type": "Identity Card",
"number": "9202204720082",
"country": "ZAF"
}
]
}
}
}
```
## Sample response
The following is a sample response showing a successful identity match.
```json theme={null}
{
"advice": {
"contains": {
"nameAddress": 2,
"nameDob": 2,
"nameDobAddress": 2,
"idNameAddress": 2,
"idNameDob": 2,
"idNameAddressDob": 2,
"idName": 2,
"sources": 2,
"isUnder18": false,
"customDecision": null,
"gbgScore": 745
}
},
"outcome": "Match"
}
```
In this example:
* Two sources matched the full ID + Name + Address + DOB combination, shown by `idNameAddressDob`: 2, which is the strongest match available.
* The GBG score is `745`, indicating high verification confidence.
* The subject is 18 or older, shown by `isUnder18`: false.
* The outcome resolves to `Match`.
This variant verifies Spanish subjects against trusted citizen data sources. It provides the most granular field-level matching of any Spain variant, including individual address component matches, phone number matching, email matching, and a "Could Not Locate" outcome.
| Detail | Value |
| --------------- | --------------------------------------------------------------------------- |
| Required inputs | Full name, current address (with country code), date of birth, phone, email |
| 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 name, last name, and initial.
| Capability | Values | Description |
| ----------------------- | ---------------------------------------------------------------------------------------- | --------------------------------------- |
| First name match result | `match`, `mismatch`, `partial match`, `not available`, `unrecognised value`, `no result` | Match result for first name. |
| Last names match result | Same values | Match result for last name. |
| Initial matches | `match`, `mismatch`, `not available`, `unrecognised value`, `no result` | Match result for the subject's initial. |
### Address match flags
Match results for the subject's address, both overall and at the component level.
| Capability | Values | Description |
| -------------------------------- | ---------------------------------------------------------------------------------------- | -------------------------------------------------- |
| Overall address match result | `match`, `mismatch`, `partial match`, `not available`, `unrecognised value`, `no result` | Overall address match result. |
| Address line 1 match flag | `match`, `mismatch`, `not available`, `unrecognised value`, `no result` | Match result for the first line of the address. |
| Postal code match result | Full value set (including `partial match`) | Match result for postal code. |
| Locality match result | Full value set | Match result for city or town. |
| Administrative area match result | Full value set | Match result for province or autonomous community. |
### Other match flags
Date of birth, phone, email, and address quality.
| Capability | Values | Description |
| --------------------------- | ----------------------------------------------------------------------- | --------------------------------- |
| Date of birth match result | Full value set (including `partial match`) | Match result for DOB. |
| Phone match result | `match`, `mismatch`, `not available`, `unrecognised value`, `no result` | Match result for phone number. |
| Email match result | Same values | Match result for email address. |
| 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 matches or partially matches and last name matches or partially matches and DOB matches or partially matches and address matches or partially matches | All four core elements confirmed. |
| `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. |
| `Could Not Locate` | First name is `not available` and last name is `not available` | The subject could not be found in the data source. |
| `Identity Mismatch` | Default | No verification path produced a passing result. |
For a full explanation of match flag values, see [match flags](/docs/go-v1/get-started/glossary#match-flags) in the glossary.
This variant performs a single-source identity verification check for Spanish subjects.
| Detail | Value |
| --------------- | ------------------------------------------------------ |
| Required inputs | Full name, current address |
| Optional inputs | Date of birth, identity card (DNI/NIE), landline phone |
The capabilities are the same as [Argentina: Single match](#argentina-single-match).
This variant performs a single-source identity verification check for Swedish subjects using their personnummer (personal identity number).
| Detail | Value |
| --------------- | ----------------------------------- |
| Required inputs | Determined by journey configuration |
| Optional inputs | None |
The capabilities are the same as [Argentina: Single match](#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. |
This variant performs a single-source check for Swedish subjects against population register data sources. Capabilities and default outcomes are the same as [Sweden: Single match personal ID](#sweden-single-match-personal-id).
This variant verifies UK subjects against Electoral Register and credit database information held by a specific credit bureau partner. It uses a different capability structure from the standard source-count pattern, counting matches at two levels of granularity (specific element combinations and broader "any match" totals) rather than the ID-based combinations used by other countries.
| Detail | Value |
| --------------- | -------------------------- |
| Required inputs | Full name, current address |
| Optional inputs | Date of birth, gender |
## Capabilities
This variant returns several count-based capabilities and an under-18 flag, described below.
## Count of matches against name and address
The number of data sources where the subject's name and address matched.
| Detail | Description |
| ------- | ----------- |
| Type | Integer |
| Range | 0–5 |
| Default | `0` |
## Count of matches against name and date of birth
The number of data sources where the subject's name and date of birth matched.
| Detail | Description |
| ------- | ----------- |
| Type | Integer |
| Range | 0–5 |
| Default | `0` |
## Count of matches against name, address and date of birth
The number of data sources where all three elements (name, address, and date of birth) matched. This is the strongest match combination for this variant and is the threshold for the `Identity Match` outcome.
| Detail | Description |
| ------- | ----------- |
| Type | Integer |
| Range | 0–5 |
| Default | `0` |
## Total sources with more than one field match
The total number of data sources that matched on more than one field (any combination). This serves as the threshold for the `Partial Identity Match` outcome. It captures cases where some elements matched but not the full name + address + DOB combination.
| Detail | Description |
| ------- | ----------- |
| Type | Integer |
| Range | 0–5 |
| Default | `0` |
## Total sources where name and address match
An aggregate count of sources confirming the name and address combination.
| Detail | Description |
| ------- | ----------- |
| Type | Integer |
| Range | 0–5 |
| Default | `0` |
## Total sources where name and date of birth match
An aggregate count of sources confirming the name and date of birth combination.
| Detail | Description |
| ------- | ----------- |
| Type | Integer |
| Range | 0–5 |
| Default | `0` |
## Is under 18
| Value | Description |
| ------- | ------------------------------------------------------ |
| `true` | The subject is under 18. |
| `false` | The subject is 18 or older. This is the default value. |
## 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. |
| `Identity Match` | Name + address + DOB match count ≥ 1 | All three core elements confirmed by at least one source. |
| `Partial Identity Match` | Total any match count ≥ 1 | At least one source matched on more than one field, but not the full combination. |
| `Identity Mismatch` | Default (no conditions matched) | No verification path produced a passing result. |
Outcome thresholds are configurable. Your organisation may have different thresholds configured based on your verification requirements.
## Configuration
You can configure how matches are counted for this variant in the module settings. These settings control which match types are included in the count totals.
| Setting | Description |
| ----------------------------------- | ---------------------------------------------------------- |
| Include ER into count | Include electoral roll matches in the count totals. |
| Include alias forename into count | Include alias (known-as) name matches in the count totals. |
| Include partial forename into count | Include partial first name matches in the count totals. |
| Include partial surname into count | Include partial last name matches in the count totals. |
| Include partial address into count | Include partial address matches in the count totals. |
## Understanding specific counts vs. total counts
The capability counters operate at two levels:
* **Specific counts** (e.g. `nameAddressMatchCount`) only increment when *exactly* the listed fields matched, with no additional fields.
* **Total counts** (e.g. `totalNameAndAddressMatchCount`) increment when those fields matched, regardless of whether additional fields also matched.
For example, if 3 sources matched on name + address + DOB and 1 source matched on name + address only:
| Counter | Value | Explanation |
| ------------------------------- | ----- | --------------------------------------------------------------------------------- |
| `nameAddressDobMatchCount` | 3 | Only the exact three-field matches |
| `nameAddressMatchCount` | 1 | Only the exact two-field match |
| `totalNameAndAddressMatchCount` | 4 | All sources where name and address matched, including the 3 that also matched DOB |
| `totalAnyMatchCount` | 4 | All sources with more than one field match |
## Input payload
The following is a sample payload used to submit identity data to the Data Verification module for processing.
```json JSON theme={null}
{
"resourceId": "your-journey-resourceID@latest",
"context": {
"subject": {
"identity": {
"firstName": "Jane",
"lastNames": ["Doe"],
"dateOfBirth": "1990-05-15",
"phones": [
{
"type": "mobile",
"number": "+447700900000"
},
{
"type": "landline",
"number": "+441234567890"
}
],
"currentAddress": {
"country": "GBR",
"locality": "London",
"thoroughfare": "High Street",
"building": "10"
}
}
}
}
}
```
Replace `your-journey-resourceID@latest` with your journey's resource ID. You can find this in the Journey Builder after publishing your journey.
## Sample response
The following is a sample response showing a successful identity match against multiple sources.
```json theme={null}
{
"result": {
"inner": [
{
"sourceType": "electoral_roll",
"advice": {
"addressMatchFlag": "match",
"lastNamesMatchFlag": "match",
"firstNameMatchFlag": "match",
"middleNamesMatchFlag": "match"
}
},
{
"sourceType": "tradeline",
"advice": {
"firstNameMatchFlag": "match",
"lastNamesMatchFlag": "match",
"middleNamesMatchFlag": "match",
"dateOfBirthMatchFlag": "match",
"addressMatchFlag": "match",
"isUnder18": false
}
},
{
"sourceType": "tradeline",
"advice": {
"firstNameMatchFlag": "match",
"lastNamesMatchFlag": "match",
"middleNamesMatchFlag": "match",
"dateOfBirthMatchFlag": "match",
"addressMatchFlag": "match",
"isUnder18": false
}
}
],
"advice": {
"nameAddressDobMatchCount": 2,
"nameAddressMatchCount": 1,
"nameDobMatchCount": 0,
"totalAnyMatchCount": 3,
"totalNameAndAddressMatchCount": 3,
"totalNameAndDobMatchCount": 2,
"isUnder18": false
},
"status": "complete",
"outcome": "Identity Match"
}
}
```
In this example:
* 2 tradeline sources matched on name, address, and DOB (`nameAddressDobMatchCount`: 2)
* 1 electoral roll source matched on name and address only (`nameAddressMatchCount`: 1)
* 0 sources matched on name and DOB exclusively (`nameDobMatchCount`: 0)
* 3 total sources had more than one field match (`totalAnyMatchCount`: 3)
* The `inner` array provides per-source detail with individual match flags for each source
For a full explanation of match flag values, see [match flags](/docs/go-v1/get-started/glossary#match-flags) in the glossary.
This variant queries a different UK credit bureau partner. Capabilities, configuration, and default outcomes are the same as [UK: Credit Bureau 1](#uk-credit-bureau-1).
| Detail | Value |
| --------------- | -------------------------- |
| Required inputs | Full name, current address |
| Optional inputs | Date of birth, gender |
This variant queries a third UK credit bureau partner. Capabilities, configuration, and default outcomes are the same as [UK: Credit Bureau 1](#uk-credit-bureau-1).
| Detail | Value |
| --------------- | -------------------------- |
| Required inputs | Full name, current address |
| Optional inputs | Date of birth, gender |
This variant verifies UK subjects against electoral roll data. It uses field-level match flags rather than source counts, providing granular detail on which individual 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 and other match flags.
### Name match flags
Match results for the subject's first, middle, and last names.
| Capability | Values | Description |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| First name matches | `match`, `initial match`, `alias match`, `partial match`, `mismatch`, `not available`, `no result`, `unrecognised value` | Match result for the subject's first name. An `initial match` indicates only the initial letter matched. An `alias match` indicates the name matched a known alias. |
| Middle names matches | `match`, `initial match`, `partial match`, `mismatch`, `not available`, `no result`, `unrecognised value` | Match result for the subject's middle name(s). |
| Last names matches | `match`, `partial match`, `mismatch`, `not available`, `no result`, `unrecognised value` | Match result for the subject's last name. |
### Other match flags
Address, date of birth, and under-18 flag.
| Capability | Values | Description |
| --------------------- | ---------------------------------------------------------------------------------------- | --------------------------------------------- |
| Address matches | `match`, `partial match`, `mismatch`, `not available`, `no result`, `unrecognised value` | Overall address match result. |
| Date of birth matches | `match`, `partial match`, `mismatch`, `not available`, `no result`, `unrecognised value` | Match result for the subject's date of birth. |
| Under 18 flag | `Y`, `N`, `no result` | Indicates whether the subject is under 18. |
## Default outcomes
The table below lists the default outcomes for this variant.
| Outcome | Condition | Description |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `Alert` | Under 18 is `Y` | The subject is under 18. |
| `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 | All four key elements confirmed. |
| `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). |
| `Could Not Locate` | First name is `not available` and last name is `not available` | The subject could not be found. No match was attempted because no record was located. |
| `Identity Mismatch` | Default (no conditions matched) | A record was located but key elements did not match. |
For a full explanation of match flag values, see [match flags](/docs/go-v1/get-started/glossary#match-flags) in the glossary.
This variant verifies UK subjects against the National ID Register. It uses field-level match flags similar to the Electoral Roll variant, but adds phone number matching capabilities (landline and mobile).
| Detail | Value |
| --------------- | ----------------------------------------- |
| Required inputs | Full name, date of birth, current address |
| Optional inputs | National Insurance Number |
## Capabilities
The name, address, date of birth, and under 18 match flags are the same as [UK: Edited and Historical Electoral Roll](#uk-edited-and-historical-electoral-roll), with one difference: first name matches also accepts `alias match` as a qualifying value for the `Identity Match` outcome (not just `match` and `partial match`).
This variant adds two phone match flags.
### Phone match flags
Match results for the subject's landline and mobile phone numbers.
| Capability | Values | Description |
| -------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------- |
| Landline phone match | `match`, `mismatch`, `not available`, `unrecognised value`, `no result` | Match result for the subject's landline phone number. |
| Mobile phone match | `match`, `mismatch`, `not available`, `unrecognised value`, `no result` | Match result for the subject's mobile phone number. |
## Default outcomes
The table below lists the default outcomes for this variant.
| Outcome | Condition | Description |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `Alert` | Under 18 is `Y` | The subject is under 18. |
| `Identity Match` | First name matches, partially matches, or alias matches and last name matches or partially matches and DOB matches or partially matches and address matches or partially matches | All four key elements confirmed. Note that `alias match` qualifies for full match here, unlike the Electoral Roll variant. |
| `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. |
| `Could Not Locate` | First name is `not available` and last name is `not available` | The subject could not be found on the register. |
| `Identity Mismatch` | Default (no conditions matched) | A record was located but key elements did not match. |
For a full explanation of match flag values, see [match flags](/docs/go-v1/get-started/glossary#match-flags) in the glossary.
This variant performs a single-source check across all available UK data sources.
| Detail | Value |
| --------------- | ------------------------------------------------------------------------------------- |
| Required inputs | Full name, date of birth, current address |
| Optional inputs | Gender, mobile phone, National Insurance Number, mother's maiden name, landline phone |
The capabilities are the same as [Argentina: Single match](#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. |
This variant is deprecated. Use [UK: Single match all sources](#uk-single-match-all-sources) or the non-legacy [UK: Credit Bureau 1](#uk-credit-bureau-1) variant instead.
This legacy variant performs a single-source check against a specific credit bureau. It uses the standard source-count capabilities (without GBG score) rather than the CRA-specific match count structure used by the non-legacy Credit Bureau variants.
| Detail | Value |
| --------------- | -------------------------- |
| Required inputs | Full name, current address |
| Optional inputs | Date of birth, gender |
The capabilities are the same as [Argentina: Single match](#argentina-single-match), excluding the GBG score. The default outcomes follow the standard pattern: ALERT → Match (Name + DOB + Address ≥ 1) → Partial Match → No Match → Error.
This variant is deprecated.
This legacy variant queries a second credit bureau. Capabilities and default outcomes are the same as [UK: Single match Credit Bureau 1 (legacy)](#uk-single-match-credit-bureau-1-legacy).
| Detail | Value |
| --------------- | -------------------------- |
| Required inputs | Full name, current address |
| Optional inputs | Date of birth |
This variant is deprecated.
This legacy variant queries a third credit bureau. Capabilities and default outcomes are the same as [UK: Single match Credit Bureau 1 (legacy)](#uk-single-match-credit-bureau-1-legacy).
| Detail | Value |
| --------------- | ----------------------------------------- |
| Required inputs | Full name, date of birth, current address |
| Optional inputs | None |
This variant performs a single-source check against the aggregated super bureau.
This variant checks whether a UK subject is recorded as deceased against mortality data source.
| Detail | Value |
| --------------- | --------------------------------- |
| Required inputs | Full name, current address |
| Optional inputs | Date of birth, previous addresses |
## Capabilities
| Capability | Values | Description |
| ----------- | --------------------- | -------------------------------------------- |
| Is deceased | `Y`, `N`, `no result` | Whether the subject is recorded as deceased. |
## Default outcomes
| Outcome | Condition | Description |
| -------------- | ------------------------------- | ----------------------------------------------- |
| `Deceased` | Is deceased is `Y` | The subject is recorded as deceased. |
| `Not Deceased` | Is deceased is `N` | The subject is not recorded as deceased. |
| `No Result` | Default (no conditions matched) | No mortality data was returned for the subject. |
## 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 JSON theme={null}
{
"resourceId": "your-journey-resourceID@latest",
"context": {
"subject": {
"identity": {
"firstName": "Jane",
"lastNames": ["Doe"],
"dateOfBirth": "1976-12-01",
"gender": "female",
"currentAddress": {
"country": "GBR",
"postalCode": "BA13 3BN",
"locality": "Westbury",
"thoroughfare": "High Street",
"building": "387"
}
}
}
}
}
```
## Sample response
The following is a sample response showing that the subject is not recorded as deceased.
```json theme={null}
{
"result": {
"inner": [
{
"sourceType": "population"
}
],
"advice": {
"deceasedFlag": "N"
},
"status": "complete",
"outcome": "Not Deceased"
}
}
```
In this example:
* The mortality data source returned `deceasedFlag: "N"`, indicating the subject is not recorded as deceased.
* The `inner` array shows the data source consulted: `population`.
* The outcome resolves to `Not Deceased`.
This variant verifies US subjects against credit bureau data. It uses field-level match flags (including SSN and phone matching) rather than the enumset-based risk code structure used by the US Source 1 variants.
| Detail | Value |
| --------------- | -------------------------- |
| Required inputs | Full name, current address |
| Optional inputs | Date of birth, phone, SSN |
## Capabilities
The table below lists the capabilities returned by this variant.
| Capability | Values | Description |
| ---------------------------- | ---------------------------------------------------------------------------------------- | -------------------------------------------- |
| First name match result | `match`, `mismatch`, `partial match`, `not available`, `unrecognised value`, `no result` | Match result for the subject's first name. |
| Middle names match result | Same values | Match result for middle name(s). |
| Last names match result | Same values | Match result for last name. |
| Date of birth match result | Same values | Match result for date of birth. |
| Overall address match result | Same values | Overall address match result. |
| SSN match result | Same values | Match result for the Social Security Number. |
| Phone match result | `match`, `mismatch`, `not available`, `unrecognised value`, `no result` | Match result for the submitted phone number. |
| Input address quality level | `1` (excellent), `2` (good), `3` (poor), `4` (not possible to validate) | Quality of the submitted address. |
## 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 | All four core elements confirmed. |
| `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 or SSN matches | Name confirmed plus at least one of DOB, address, or SSN. |
| `Could Not Locate` | First name is `not available` and last name is `not available` | The subject could not be found. |
| `Identity Mismatch` | Default | No verification path produced a passing result. |
## Input payload
The following is a sample payload used to submit identity data to the Data Verification module for processing.
```json JSON theme={null}
{
"resourceId": "your-journey-resourceID@latest",
"context": {
"subject": {
"identity": {
"firstName": "Jane",
"middleNames": ["Marie"],
"lastNames": ["Doe"],
"dateOfBirth": "1990-05-15",
"currentAddress": {
"premise": "100",
"thoroughfare": "Main Street",
"locality": "New York",
"postalCode": "10001",
"country": "USA"
},
"phones": [
{
"type": "mobile",
"number": "+12125550100"
}
]
},
"accounts": [
{
"type": "bank",
"accountNumber": "000123456789",
"sortCode": "021000021"
}
],
"documents": [
{
"type": "drivers_licence",
"number": "D12345678",
"documentVersionNumber": "01"
}
]
}
}
}
```
Replace `your-journey-resourceID@latest` with your journey's resource ID. You can find this in the Journey Builder after publishing your journey.
## Sample response
The following is a sample response for a successful identity match.
```json JSON theme={null}
{
"outcome": "Identity Match",
"advice": {}
}
```
For a full explanation of match flag values, see [match flags](/docs/go-v1/get-started/glossary#match-flags) in the glossary.
This variant performs a US identity verification check via a credit bureau. It uses a hybrid capability structure that combines individual field-level match flags with the full enumset-based risk code suite documented under [US: Source 1 (Legacy)](#us-source-1-legacy). The bureau is selected through credential routing. Contact GBG for bureau selection guidance.
| Detail | Value |
| --------------- | -------------------------------------------------------------------- |
| Required inputs | Full name, current address |
| Optional inputs | Date of birth, previous addresses, mobile phone, personal email, SSN |
## Capabilities
This variant returns field-level match flags grouped into name, address, and other categories, alongside the full enumset risk code suite.
### Name match flags
Match results for the subject's first and last names.
| Capability | Values | Description |
| ------------------ | ------------------------------------------------------------------ | ------------------------------------------ |
| First name matches | `match`, `partial match`, `mismatch`, `not available`, `no result` | Match result for the subject's first name. |
| Last names matches | Same values | 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 matches | `match`, `partial match`, `mismatch`, `not available`, `no result` | 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/ZIP code. |
| Building matches | Same values | Match result for the building or house number. |
| Administrative area matches | Same values | Match result for the state. |
### Other match flags
Date of birth and Social Security Number.
| Capability | Values | Description |
| ------------------------------- | ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Date of birth matches | `match`, `month level match`, `year level match`, `partial match`, `mismatch`, `not available`, `no result` | Match result for DOB. `month level match` indicates the month and year matched but the day did not. `year level match` indicates only the year matched. |
| Social insurance number matches | `match`, `partial match`, `mismatch`, `not available`, `no result` | Match result for the SSN. |
### Enumset risk code capabilities
This variant also returns all enumset risk code categories documented under [US: Source 1 (Legacy)](#us-source-1-legacy): subject risk codes, address risk codes (including warm address alerts), DOB risk codes, SSN risk codes, acceptance result, match result, COPPA alert, alert list, Trust USA risk codes, and Trust USA result.
## Default outcomes
The outcome logic combines the match result and acceptance result capabilities. This is the same as [US: Source 1 (Legacy)](#us-source-1-legacy). The individual field-match flags are not used in the default outcome logic. They are available for custom evaluation rules.
| Outcome | Condition | Description |
| ------------------ | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| `Match` | Match result includes `result.match` and acceptance result includes `id.success` | Subject located and identity check passed. |
| `Match Restricted` | Match result includes `result.match.restricted` | Subject located but match is restricted (for example, COPPA, deceased). |
| `No Match` | Match result includes `result.match` and acceptance result includes `id.failure` | Subject located but identity check failed. |
| `Could Not Locate` | Match result includes `result.no.match` and acceptance result includes `id.failure` | Subject could not be found in data sources. |
| `Partial Match` | Match result includes `result.match` and acceptance result includes `id.partial` | Partial verification — some elements confirmed but not all. |
| `Error` | Default (no conditions matched) | An unexpected error occurred. |
This variant queries a different credential-routed credit bureau. Capabilities and default outcomes are the same as [US: Credit Bureau 1](#us-credit-bureau-1).
| Detail | Value |
| --------------- | -------------------------------------------------------------------- |
| Required inputs | Full name, current address |
| Optional inputs | Date of birth, previous addresses, mobile phone, personal email, SSN |
This variant performs a comprehensive US identity verification check using name and address as required inputs, with optional DOB, SSN, phone, and email. It returns an extensive set of enumset-based risk code capabilities rather than simple match flags. This capability structure is unique to US variants and provides deep fraud and risk intelligence alongside identity matching.
| Detail | Value |
| --------------- | -------------------------------------------------------------------- |
| Required inputs | Full name, current address |
| Optional inputs | Date of birth, previous addresses, mobile phone, personal email, SSN |
## Capabilities
All US Source 1 variants share the same capability set. The capabilities are enumset types. Each can contain zero or more result codes simultaneously.
## Subject risk codes
Flags indicating issues with the subject record itself.
| Code | Description |
| ---------------------- | ------------------------------------------------------------------------------ |
| Subject is Deceased | The subject is recorded as deceased. |
| Multiple Records Found | More than one record matched the submitted identity elements. |
| Thin File | The subject has a limited data history, which reduces verification confidence. |
| Data Strength Alert | The data available for the subject is insufficient for a confident match. |
## Name risk codes
| Code | Description |
| ------------------------- | ---------------------------------------------------------- |
| Last Name Does Not Match | The submitted last name did not match the located record. |
| First Name Does Not Match | The submitted first name did not match the located record. |
## Address risk codes
This is the largest capability category, covering match failures, deliverability issues, behavioural signals, and warm address alerts.
* **Match codes**: Address Does Not Match, Street Number Does Not Match, Street Name Does Not Match, Address Does Not Match Within Tolerance, City Does Not Match, State Does Not Match, Zip Code Does Not Match.
* **Deliverability signals**: Input Address Is Not Deliverable, Located Address Is Not Deliverable, Input Invalid Delivery Address, Input Address is Deliverable After Dropping Building Number, Input Address is a General Delivery Address, Input Address Missing Building Number, Input Premise Number Invalid, Input Box Number Missing, Input Box Number Invalid, Input Address is Valid but Does Not Receive USPS Mail, Input Sub-Building Number Needs Correction.
* **Behaviour signals**: Newer Record Found (a more recent address exists), Address Velocity Alert (frequent address changes), Address Stability Alert, Address Longevity Alert (short time at address), Address Location Alert, Single Address in File, Alternate Address Alert.
* **Address type signals**: Input Address is a PO Box, Located Address is a PO Box, Input Address is a Military Address, Input Address is a Business Address, High Risk Address Alert.
* **Warm address alerts**: These flag addresses associated with specific institutional locations. Each alert exists in two forms: one for the located address and one for the input address. Location types include: Prison, Hospital, Mail Drop, Hotel, Campground, College/University, and USPO (US Post Office).
## DOB risk codes
| Code | Description |
| ------------------------------------------- | ----------------------------------------------------- |
| YOB Does Not Match | Year of birth did not match. |
| MOB Does Not Match | Month of birth did not match. |
| YOB Does Not Match, Within 1 Year Tolerance | Year of birth is off by one year. |
| DOB or YOB Not Available | No date of birth or year of birth data is available. |
| MOB Not Available | No month of birth data is available. |
| Age Below Minimum | The subject's age is below the configured minimum. |
| Age Above Maximum | The subject's age exceeds the configured maximum. |
| Day of Birth Does Not Match | The day component of the date of birth did not match. |
| Day of Birth Not Available | No day of birth data is available. |
## SSN risk codes
Codes for SSN matching, validation, and issuance anomalies. Includes both current and legacy code formats.
| Code | Description |
| ------------------------------------ | --------------------------------------------------------------------------------- |
| SSN Does Not Match | The submitted SSN did not match. |
| SSN Does Not Match, Within Tolerance | The SSN is off by one digit. |
| SSN Not Available | No SSN data is available for the subject. |
| SSN Is Invalid | The submitted SSN is not a valid format. |
| Input SSN is an ITIN | The submitted number is an Individual Taxpayer Identification Number, not an SSN. |
| ITIN Located | An ITIN was found associated with the subject. |
| SSN Issued Prior to DOB | The SSN was issued before the subject's recorded date of birth. |
| SSN Tied to Multiple Names | The SSN is associated with more than one identity. |
## Acceptance result (score card)
| Code | Description |
| ---------------------- | ---------------------------------------------------------- |
| `id.success` (Pass) | The identity check passed the configured score card rules. |
| `id.failure` (Fail) | The identity check failed. |
| `id.partial` (Partial) | The identity check partially passed. |
## Match result
| Code | Description |
| -------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `result.match` (Match) | The subject was located in the data sources. |
| `result.no.match` (No Match) | The subject could not be located. |
| `result.match.restricted` (Match Restricted) | The subject was located but the match is restricted (e.g. due to a COPPA alert or deceased status). |
## COPPA alert
| Code | Description |
| ----------- | --------------------------------------------------------------------------------------------------------------------- |
| COPPA Alert | The subject appears to be under 13 years of age, triggering the Children's Online Privacy Protection Act restriction. |
## Alert list
Flags for subjects or elements that appear on configured alert lists.
| Code | Description |
| ------------------------------------ | ---------------------------------------------------------------- |
| SSN Alert | The SSN appears on an alert list. |
| Address Alert | The address appears on an alert list. |
| IP Alert | The IP address appears on an alert list. |
| Phone Alert | The phone number appears on an alert list. |
| Email Alert | The email address appears on an alert list. |
| Domain Alert | The email domain appears on an alert list. |
| Document Number Alert | A document number appears on an alert list. |
| Address Street Address and ZIP Alert | The street address and ZIP combination appears on an alert list. |
| Located SSN Alert | The SSN found in the located record appears on an alert list. |
## Trust USA risk codes
An extensive set of element-pair risk codes that indicate which specific combinations of input (I-prefix) and located (L-prefix) identity elements were flagged. These codes use short identifiers (e.g. `IADDR` for input street address, `LSSN9` for located SSN9). The full set includes combinations of name, address, SSN, phone, email, IP address, and document elements. Also includes overall `pass`, `fail`, and `refer` result codes.
## Trust USA result
| Code | Description |
| ------- | ------------------------------------------- |
| `pass` | The Trust USA check passed. |
| `fail` | The Trust USA check failed. |
| `refer` | The Trust USA check requires manual review. |
## Default outcomes
The outcome logic combines the match result and acceptance result capabilities.
| Outcome | Condition | Description |
| ------------------ | ----------------------------------------------------------------------------------- | --------------------------------------------------------------- |
| `Match` | Match result includes `result.match` and acceptance result includes `id.success` | Subject located and identity check passed. |
| `Match Restricted` | Match result includes `result.match.restricted` | Subject located but match is restricted (e.g. COPPA, deceased). |
| `No Match` | Match result includes `result.match` and acceptance result includes `id.failure` | Subject located but identity check failed. |
| `Could Not Locate` | Match result includes `result.no.match` and acceptance result includes `id.failure` | Subject could not be found in data sources. |
| `Partial Match` | Match result includes `result.match` or acceptance result includes `id.partial` | Partial verification. Some elements confirmed, but not all. |
| `Error` | Default | An unexpected error occurred. |
For a full explanation of match flag values, see [match flags](/docs/go-v1/get-started/glossary#match-flags) in the glossary.
This variant requires both DOB and SSN, providing the strongest matching configuration. Capabilities and default outcomes are the same as [US: Source 1](#us-source-1).
| Detail | Value |
| --------------- | ------------------------------------------------ |
| Required inputs | Full name, date of birth, current address, SSN |
| Optional inputs | Previous addresses, mobile phone, personal email |
This variant adds date of birth as a required input for stronger matching confidence. All other capabilities and default outcomes are the same as [US: Source 1](#us-source-1).
| Detail | Value |
| --------------- | ----------------------------------------------------- |
| Required inputs | Full name, date of birth, current address |
| Optional inputs | Previous addresses, mobile phone, personal email, SSN |
This variant adds SSN as a required input. All other capabilities and default outcomes are the same as [US: Source 1](#us-source-1).
| Detail | Value |
| --------------- | --------------------------------------------------------------- |
| Required inputs | Full name, current address, SSN |
| Optional inputs | Previous addresses, mobile phone, personal email, date of birth |