Identity Intelligence - GBG Documentation

Identity Enrichment Enhanced

Capabilities

The module returns the following capabilities.

Supplier confidence

Indicates the confidence the Supplier has in the accuracy of the enriched data

Code	Label	Description
`High`	High	High
`Medium`	Medium	Medium
`Low`	Low	Low
`No Data`	No Data	No Data

Default outcomes

The module is pre-configured with the following default outcomes, which can be used in evaluation and routing logic within the journey designer.

Outcome	Condition	Description
`Enrichment Success`	Supplier Confidence is `High` or Supplier Confidence is `Medium`	The supplier returned enriched data with sufficient confidence to be relied on.
`Error`	—	The module couldn’t complete the check, for example because the supplier was unavailable.
`Enrichment Fail`	default, when no conditions matched	No enriched data was returned, or the supplier’s confidence was too low to be relied on.

Input payload

The following is a sample payload used to submit data to the ** Identity Enrichment Enhanced** module for processing.

JSON

{
  "context": {
    "subject": {
      "uid": "variant-test-user",
      "identity": {
        "firstName": "Lost",
        "middleNames": [
          "Some"
        ],
        "lastNames": [
          "Data"
        ],
        "dateOfBirth": "2007-03-09",
        "currentAddress": {
          "premise": "9A",
          "thoroughfare": "No Street",
          "locality": "No Value",
          "postalCode": "A09 1AA",
          "country": "GBR"
        },
        "phones": [
          {
            "type": "mobile",
            "number": "+447795090909"
          }
        ]
      },
      "accounts": [
        {
          "type": "Bank Account",
          "accountNumber": "09345678",
          "sortCode": "01-02-09"
        }
      ],
      "documents": [
        {
          "type": "Driving License",
          "number": "NZ000909",
          "cardNumber": "909"
        }
      ]
    }
  }
}

Field	Required	Description
`FullName`	Yes	The subject’s full name, including given and family names.
`MobilePhone`	Yes	The subject’s mobile phone number, used to look up the associated address.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "outcome": "Enrichment Fail",
    "advice": {}
  }
}

Australia - Identity Enrichment Enhanced

Capabilities

The module returns the following capabilities.

Meets age policy

Whether the subject is at or above the requested age boundary.

Code	Label	Description
`Y`	Y	Is at or above the requested age boundary
`N`	N	Is below the requested age boundary
`unknown`	unknown	No date of birth available to calculate

Supplier confidence

Indicates the confidence the Supplier has in the accuracy of the enriched data

Code	Label	Description
`High`	High	High
`Medium`	Medium	Medium
`Low`	Low	Low
`No Data`	No Data	No Data

Default outcomes

The module is pre-configured with the following default outcomes, which can be used in evaluation and routing logic within the journey designer.

Outcome	Condition	Description
`Enrichment Success`	Supplier Confidence is `High` or Supplier Confidence is `Medium`	The supplier returned enriched data with sufficient confidence to be relied on.
`Error`	—	The module couldn’t complete the check, for example because the supplier was unavailable.
`Enrichment Fail`	default, when no conditions matched	No enriched data was returned, or the supplier’s confidence was too low to be relied on.

Input payload

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

JSON

{
  "context": {
    "subject": {
      "uid": "variant-test-user",
      "identity": {
        "firstName": "Lost",
        "middleNames": [
          "Some"
        ],
        "lastNames": [
          "Data"
        ],
        "dateOfBirth": "2007-03-09",
        "currentAddress": {
          "premise": "9A",
          "thoroughfare": "No Street",
          "locality": "No Value",
          "postalCode": "A09 1AA",
          "country": "GBR"
        },
        "phones": [
          {
            "type": "mobile",
            "number": "+447795090909"
          }
        ]
      },
      "accounts": [
        {
          "type": "Bank Account",
          "accountNumber": "09345678",
          "sortCode": "01-02-09"
        }
      ],
      "documents": [
        {
          "type": "Driving License",
          "number": "NZ000909",
          "cardNumber": "909"
        }
      ]
    }
  }
}

Field	Required	Description
`MobilePhone`	Yes	The subject’s mobile phone number, used to look up the associated address.
`FullName`	Yes	The subject’s full name, including given and family names.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "outcome": "Enrichment Fail",
    "advice": {}
  }
}

Australia - Identity Enrichment Enhanced 2

Capabilities

The module returns the following capabilities.

Supplier confidence

Indicates the confidence the Supplier has in the accuracy of the enriched data

Code	Label	Description
`Very High`	Very High	Very High
`High`	High	High
`Medium`	Medium	Medium
`Low`	Low	Low
`No Data`	No Data	No Data

Meets age policy

Whether the subject is at or above the requested age boundary.

Code	Label	Description
`Y`	Y	Yes
`N`	N	No
`unknown`	unkown	unknown

Default outcomes

The module is pre-configured with the following default outcomes, which can be used in evaluation and routing logic within the journey designer.

Outcome	Condition	Description
`Enrichment Success`	Supplier Confidence is `High` or Supplier Confidence is `Medium`	The supplier returned enriched data with sufficient confidence to be relied on.
`Error`	—	The module couldn’t complete the check, for example because the supplier was unavailable.
`Enrichment Fail`	default, when no conditions matched	No enriched data was returned, or the supplier’s confidence was too low to be relied on.

Input payload

The following is a sample payload used to submit data to the Australia - Identity Enrichment Enhanced 2 module for processing.

JSON

{
  "context": {
    "subject": {
      "uid": "variant-test-user",
      "identity": {
        "firstName": "Lost",
        "middleNames": [
          "Some"
        ],
        "lastNames": [
          "Data"
        ],
        "dateOfBirth": "2007-03-09",
        "currentAddress": {
          "premise": "9A",
          "thoroughfare": "No Street",
          "locality": "No Value",
          "postalCode": "A09 1AA",
          "country": "GBR"
        },
        "phones": [
          {
            "type": "mobile",
            "number": "+447795090909"
          }
        ]
      },
      "accounts": [
        {
          "type": "Bank Account",
          "accountNumber": "09345678",
          "sortCode": "01-02-09"
        }
      ],
      "documents": [
        {
          "type": "Driving License",
          "number": "NZ000909",
          "cardNumber": "909"
        }
      ]
    }
  }
}

Field	Required	Description
`MobilePhone`	Yes	The subject’s mobile phone number, used to look up the associated address.
`FullName`	Yes	The subject’s full name, including given and family names.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "outcome": "Enrichment Fail",
    "advice": {}
  }
}

France - Identity Enrichment Enhanced

Capabilities

The module returns the following capabilities.

Supplier confidence

Indicates the confidence the Supplier has in the accuracy of the enriched data

Code	Label	Description
`High`	High	High
`Medium`	Medium	Medium
`Low`	Low	Low
`No Data`	No Data	No Data

Meets age policy

Whether the subject is at or above the requested age boundary.

Code	Label	Description
`Y`	Y	Is at or above the requested age boundary
`N`	N	Is below the requested age boundary
`unknown`	unknown	No date of birth available to calculate

Default outcomes

The module is pre-configured with the following default outcomes, which can be used in evaluation and routing logic within the journey designer.

Outcome	Condition	Description
`Enrichment Success`	Supplier Confidence is `High` or Supplier Confidence is `Medium`	The supplier returned enriched data with sufficient confidence to be relied on.
`Error`	—	The module couldn’t complete the check, for example because the supplier was unavailable.
`Enrichment Fail`	default, when no conditions matched	No enriched data was returned, or the supplier’s confidence was too low to be relied on.

Input payload

The following is a sample payload used to submit data to the France - Identity Enrichment Enhanced module for processing.

JSON

{
  "context": {
    "subject": {
      "uid": "variant-test-user",
      "identity": {
        "firstName": "Lost",
        "middleNames": [
          "Some"
        ],
        "lastNames": [
          "Data"
        ],
        "dateOfBirth": "2007-03-09",
        "currentAddress": {
          "premise": "9A",
          "thoroughfare": "No Street",
          "locality": "No Value",
          "postalCode": "A09 1AA",
          "country": "GBR"
        },
        "phones": [
          {
            "type": "mobile",
            "number": "+447795090909"
          }
        ]
      },
      "accounts": [
        {
          "type": "Bank Account",
          "accountNumber": "09345678",
          "sortCode": "01-02-09"
        }
      ],
      "documents": [
        {
          "type": "Driving License",
          "number": "NZ000909",
          "cardNumber": "909"
        }
      ]
    }
  }
}

Field	Required	Description
`MobilePhone`	Yes	The subject’s mobile phone number, used to look up the associated address.
`FullName`	Yes	The subject’s full name, including given and family names.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "outcome": "Enrichment Fail",
    "advice": {}
  }
}

Germany - Identity Enrichment Enhanced

Capabilities

The module returns the following capabilities.

Supplier confidence

Indicates the confidence the Supplier has in the accuracy of the enriched data

Code	Label	Description
`High`	High	High
`Medium`	Medium	Medium
`Low`	Low	Low
`No Data`	No Data	No Data

Meets age policy

Whether the subject is at or above the requested age boundary.

Code	Label	Description
`Y`	Y	Is at or above the requested age boundary
`N`	N	Is below the requested age boundary
`unknown`	unknown	No date of birth available to calculate

Default outcomes

The module is pre-configured with the following default outcomes, which can be used in evaluation and routing logic within the journey designer.

Outcome	Condition	Description
`Enrichment Success`	Supplier Confidence is `High` or Supplier Confidence is `Medium`	The supplier returned enriched data with sufficient confidence to be relied on.
`Error`	—	The module couldn’t complete the check, for example because the supplier was unavailable.
`Enrichment Fail`	default, when no conditions matched	No enriched data was returned, or the supplier’s confidence was too low to be relied on.

Input payload

The following is a sample payload used to submit data to the Germany - Identity Enrichment Enhanced module for processing.

JSON

{
  "context": {
    "subject": {
      "uid": "variant-test-user",
      "identity": {
        "firstName": "Lost",
        "middleNames": [
          "Some"
        ],
        "lastNames": [
          "Data"
        ],
        "dateOfBirth": "2007-03-09",
        "currentAddress": {
          "premise": "9A",
          "thoroughfare": "No Street",
          "locality": "No Value",
          "postalCode": "A09 1AA",
          "country": "GBR"
        },
        "phones": [
          {
            "type": "mobile",
            "number": "+447795090909"
          }
        ]
      },
      "accounts": [
        {
          "type": "Bank Account",
          "accountNumber": "09345678",
          "sortCode": "01-02-09"
        }
      ],
      "documents": [
        {
          "type": "Driving License",
          "number": "NZ000909",
          "cardNumber": "909"
        }
      ]
    }
  }
}

Field	Required	Description
`MobilePhone`	Yes	The subject’s mobile phone number, used to look up the associated address.
`FullName`	Yes	The subject’s full name, including given and family names.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "outcome": "Enrichment Fail",
    "advice": {}
  }
}

Identity Enrichment

Capabilities

The module returns the following capabilities.

Match

Whether a match was found

Detail	Description
Type	Boolean
Default	`false`

Default outcomes

The module is pre-configured with the following default outcomes, which can be used in evaluation and routing logic within the journey designer.

Outcome	Condition	Description
`Enrichment Success`	Match isTrue	The supplied name and phone number matched a record, and address details were returned.
`Enrichment Fail`	Match isFalse	The supplied name and phone number didn’t match a record, so no address details were returned.
`Error`	default, when no conditions matched	The module couldn’t complete the check, for example because the supplier was unavailable.

Input payload

The following is a sample payload used to submit data to the Identity Enrichment module for processing.

JSON

{
  "context": {
    "subject": {
      "identity": {
        "firstName": "John",
        "lastNames": [
          "Smith"
        ],
        "phones": [
          {
            "type": "mobile",
            "number": "07868111000"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`MobilePhone`	Yes	The subject’s mobile phone number, used to look up the associated address.
`FullName`	No	The subject’s full name, including given and family names.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {
      "match": true
    },
    "outcome": "Enrichment Success"
  }
}

New Zealand - Identity Enrichment Enhanced

Capabilities

The module returns the following capabilities.

Supplier confidence

Indicates the confidence the Supplier has in the accuracy of the enriched data

Code	Label	Description
`High`	High	High
`Medium`	Medium	Medium
`Low`	Low	Low
`No Data`	No Data	No Data

Meets age policy

Whether the subject is at or above the requested age boundary.

Code	Label	Description
`Y`	Y	Is at or above the requested age boundary
`N`	N	Is below the requested age boundary
`unknown`	unknown	No date of birth available to calculate

Default outcomes

The module is pre-configured with the following default outcomes, which can be used in evaluation and routing logic within the journey designer.

Outcome	Condition	Description
`Enrichment Success`	Supplier Confidence is `High` or Supplier Confidence is `Medium`	The supplier returned enriched data with sufficient confidence to be relied on.
`Error`	—	The module couldn’t complete the check, for example because the supplier was unavailable.
`Enrichment Fail`	default, when no conditions matched	No enriched data was returned, or the supplier’s confidence was too low to be relied on.

Input payload

The following is a sample payload used to submit data to the New Zealand - Identity Enrichment Enhanced module for processing.

JSON

{
  "context": {
    "subject": {
      "uid": "variant-test-user",
      "identity": {
        "firstName": "Lost",
        "middleNames": [
          "Some"
        ],
        "lastNames": [
          "Data"
        ],
        "dateOfBirth": "2007-03-09",
        "currentAddress": {
          "premise": "9A",
          "thoroughfare": "No Street",
          "locality": "No Value",
          "postalCode": "A09 1AA",
          "country": "GBR"
        },
        "phones": [
          {
            "type": "mobile",
            "number": "+447795090909"
          }
        ]
      },
      "accounts": [
        {
          "type": "Bank Account",
          "accountNumber": "09345678",
          "sortCode": "01-02-09"
        }
      ],
      "documents": [
        {
          "type": "Driving License",
          "number": "NZ000909",
          "cardNumber": "909"
        }
      ]
    }
  }
}

Field	Required	Description
`MobilePhone`	Yes	The subject’s mobile phone number, used to look up the associated address.
`FullName`	Yes	The subject’s full name, including given and family names.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "outcome": "Enrichment Fail",
    "advice": {}
  }
}

Poland - Identity Enrichment Enhanced

Capabilities

The module returns the following capabilities.

Meets age policy

Whether the subject is at or above the requested age boundary.

Code	Label	Description
`Y`	Y	Is at or above the requested age boundary
`N`	N	Is below the requested age boundary
`unknown`	unknown	No date of birth available to calculate

Supplier confidence

Indicates the confidence the Supplier has in the accuracy of the enriched data

Code	Label	Description
`High`	High	High
`Medium`	Medium	Medium
`Low`	Low	Low
`No Data`	No Data	No Data

Default outcomes

The module is pre-configured with the following default outcomes, which can be used in evaluation and routing logic within the journey designer.

Outcome	Condition	Description
`Enrichment Success`	Supplier Confidence is `High` or Supplier Confidence is `Medium`	The supplier returned enriched data with sufficient confidence to be relied on.
`Error`	—	The module couldn’t complete the check, for example because the supplier was unavailable.
`Enrichment Fail`	default, when no conditions matched	No enriched data was returned, or the supplier’s confidence was too low to be relied on.

Input payload

The following is a sample payload used to submit data to the Poland - Identity Enrichment Enhanced module for processing.

JSON

{
  "context": {
    "subject": {
      "uid": "variant-test-user",
      "identity": {
        "firstName": "Lost",
        "middleNames": [
          "Some"
        ],
        "lastNames": [
          "Data"
        ],
        "dateOfBirth": "2007-03-09",
        "currentAddress": {
          "premise": "9A",
          "thoroughfare": "No Street",
          "locality": "No Value",
          "postalCode": "A09 1AA",
          "country": "GBR"
        },
        "phones": [
          {
            "type": "mobile",
            "number": "+447795090909"
          }
        ]
      },
      "accounts": [
        {
          "type": "Bank Account",
          "accountNumber": "09345678",
          "sortCode": "01-02-09"
        }
      ],
      "documents": [
        {
          "type": "Driving License",
          "number": "NZ000909",
          "cardNumber": "909"
        }
      ]
    }
  }
}

Field	Required	Description
`MobilePhone`	Yes	The subject’s mobile phone number, used to look up the associated address.
`FullName`	Yes	The subject’s full name, including given and family names.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "outcome": "Enrichment Fail",
    "advice": {}
  }
}

Portugal - Identity Enrichment Enhanced

Capabilities

The module returns the following capabilities.

Supplier confidence

Indicates the confidence the Supplier has in the accuracy of the enriched data

Code	Label	Description
`High`	High	High
`Medium`	Medium	Medium
`Low`	Low	Low
`No Data`	No Data	No Data

Meets age policy

Whether the subject is at or above the requested age boundary.

Code	Label	Description
`Y`	Y	Is at or above the requested age boundary
`N`	N	Is below the requested age boundary
`unknown`	unknown	No date of birth available to calculate

Default outcomes

The module is pre-configured with the following default outcomes, which can be used in evaluation and routing logic within the journey designer.

Outcome	Condition	Description
`Enrichment Success`	Supplier Confidence is `High` or Supplier Confidence is `Medium`	The supplier returned enriched data with sufficient confidence to be relied on.
`Error`	—	The module couldn’t complete the check, for example because the supplier was unavailable.
`Enrichment Fail`	default, when no conditions matched	No enriched data was returned, or the supplier’s confidence was too low to be relied on.

Input payload

The following is a sample payload used to submit data to the Portugal - Identity Enrichment Enhanced module for processing.

JSON

{
  "context": {
    "subject": {
      "uid": "variant-test-user",
      "identity": {
        "firstName": "Lost",
        "middleNames": [
          "Some"
        ],
        "lastNames": [
          "Data"
        ],
        "dateOfBirth": "2007-03-09",
        "currentAddress": {
          "premise": "9A",
          "thoroughfare": "No Street",
          "locality": "No Value",
          "postalCode": "A09 1AA",
          "country": "GBR"
        },
        "phones": [
          {
            "type": "mobile",
            "number": "+447795090909"
          }
        ]
      },
      "accounts": [
        {
          "type": "Bank Account",
          "accountNumber": "09345678",
          "sortCode": "01-02-09"
        }
      ],
      "documents": [
        {
          "type": "Driving License",
          "number": "NZ000909",
          "cardNumber": "909"
        }
      ]
    }
  }
}

Field	Required	Description
`MobilePhone`	Yes	The subject’s mobile phone number, used to look up the associated address.
`FullName`	Yes	The subject’s full name, including given and family names.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "outcome": "Enrichment Fail",
    "advice": {}
  }
}

Spain - Identity Enrichment Enhanced

Capabilities

The module returns the following capabilities.

Supplier confidence

Indicates the confidence the Supplier has in the accuracy of the enriched data

Code	Label	Description
`High`	High	High
`Medium`	Medium	Medium
`Low`	Low	Low
`No Data`	No Data	No Data

Meets age policy

Whether the subject is at or above the requested age boundary.

Code	Label	Description
`Y`	Y	Is at or above the requested age boundary
`N`	N	Is below the requested age boundary
`unknown`	unknown	No date of birth available to calculate

Default outcomes

The module is pre-configured with the following default outcomes, which can be used in evaluation and routing logic within the journey designer.

Outcome	Condition	Description
`Enrichment Success`	Supplier Confidence is `High` or Supplier Confidence is `Medium`	The supplier returned enriched data with sufficient confidence to be relied on.
`Error`	—	The module couldn’t complete the check, for example because the supplier was unavailable.
`Enrichment Fail`	default, when no conditions matched	No enriched data was returned, or the supplier’s confidence was too low to be relied on.

Input payload

The following is a sample payload used to submit data to the Spain - Identity Enrichment Enhanced module for processing.

JSON

{
  "context": {
    "subject": {
      "uid": "variant-test-user",
      "identity": {
        "firstName": "Lost",
        "middleNames": [
          "Some"
        ],
        "lastNames": [
          "Data"
        ],
        "dateOfBirth": "2007-03-09",
        "currentAddress": {
          "premise": "9A",
          "thoroughfare": "No Street",
          "locality": "No Value",
          "postalCode": "A09 1AA",
          "country": "GBR"
        },
        "phones": [
          {
            "type": "mobile",
            "number": "+447795090909"
          }
        ]
      },
      "accounts": [
        {
          "type": "Bank Account",
          "accountNumber": "09345678",
          "sortCode": "01-02-09"
        }
      ],
      "documents": [
        {
          "type": "Driving License",
          "number": "NZ000909",
          "cardNumber": "909"
        }
      ]
    }
  }
}

Field	Required	Description
`MobilePhone`	Yes	The subject’s mobile phone number, used to look up the associated address.
`FullName`	Yes	The subject’s full name, including given and family names.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "outcome": "Enrichment Fail",
    "advice": {}
  }
}

​Capabilities

​Supplier confidence

​Default outcomes

​Input payload

​Sample response

​Capabilities

​Meets age policy

​Supplier confidence

​Default outcomes

​Input payload

​Sample response

​Capabilities

​Supplier confidence

​Meets age policy

​Default outcomes

​Input payload

​Sample response

​Capabilities

​Supplier confidence

​Meets age policy

​Default outcomes

​Input payload

​Sample response

​Capabilities

​Supplier confidence

​Meets age policy

​Default outcomes

​Input payload

​Sample response

​Capabilities

​Match

​Default outcomes

​Input payload

​Sample response

​Capabilities

​Supplier confidence

​Meets age policy

​Default outcomes

​Input payload

​Sample response

​Capabilities

​Meets age policy

​Supplier confidence

​Default outcomes

​Input payload

​Sample response

​Capabilities

​Supplier confidence

​Meets age policy

​Default outcomes

​Input payload

​Sample response

​Capabilities

​Supplier confidence

​Meets age policy

​Default outcomes

​Input payload

​Sample response

Capabilities

Supplier confidence

Default outcomes

Input payload

Sample response

Capabilities

Meets age policy

Supplier confidence

Default outcomes

Input payload

Sample response

Capabilities

Supplier confidence

Meets age policy

Default outcomes

Input payload

Sample response

Capabilities

Supplier confidence

Meets age policy

Default outcomes

Input payload

Sample response

Capabilities

Supplier confidence

Meets age policy

Default outcomes

Input payload

Sample response

Capabilities

Match

Default outcomes

Input payload

Sample response

Capabilities

Supplier confidence

Meets age policy

Default outcomes

Input payload

Sample response

Capabilities

Meets age policy

Supplier confidence

Default outcomes

Input payload

Sample response

Capabilities

Supplier confidence

Meets age policy

Default outcomes

Input payload

Sample response

Capabilities

Supplier confidence

Meets age policy

Default outcomes

Input payload

Sample response