Phone Insights - GBG Documentation

US phone verification

Performs phone-to-name (N2P) matching to check whether the submitted phone number is associated with the stated identity. Requires the subject’s full name and mobile phone.

Detail	Value
Required inputs	Full name, mobile phone

Capabilities

This variant returns a phone match result alongside risk signals that describe the number itself.

Result capabilities

Code	Label	Description
`idphone.match`	ID phone matched	The phone number is associated with the stated identity.
`idphone.does.not.match`	ID phone does not match	The phone number is not associated with the stated identity.
`idphone.not.available`	ID phone not available	No phone data could be located.

Risk capabilities

Code	Label	Description
`resultcode.invalid.phone.number`	Invalid phone number	The submitted phone number is not valid.
`resultcode.phone.data.exists`	Phone data exists	Phone data was found for the number.
`idphone.name.match`	ID phone name matched	The name associated with the phone number matches.
`idphone.proximity`	ID phone proximity	The phone number is in proximity to the stated address.
`idphone.pager`	ID phone pager	The number is a pager, not a phone.
`idphone.wireless`	ID phone wireless	The number is a wireless/mobile number.

Trust USA risk capabilities

Value	Description
`ADDR4`	Street Address w/ SSN4
`ADDR`	Street Address
`IADDR4`	Street Address w/ SSN4
`IADDR`	Street Address
`IALTADDR`	Alternate Street Address
`IALT`	Alternate Street Address
`IBADDR`	Business Address
`IBDBA`	Business DBA Name
`IBDBANAME`	Business DBA Name
`IBFEIN`	Business FEIN
`IBNAME`	Business Name
`IDOC`	Document Number
`IEMAILDOM`	Email Domain
`IEMAIL`	Email Address
`IEMAILIADDR`	Email Address w/ Input Street Address
`IEMAILIIPADDR`	Email Address w/ Input IP Address
`IEMAILIPHONE`	Email Address w/ Input Phone Number
`IEMAILISSN9`	Email Address w/ Input SSN9
`IFIRST`	First Name
`IIPADDRIADDR`	IP Address w/ Input Street Address
`IIPADDR`	IP Address
`IIPADDRIPHONE`	IP Address w/ Input Phone Number
`IIPADDRISSN9`	IP Address w/ Input SSN9
`IIP`	IP Address
`ILAST`	Last Name
`ILNAME4`	Last Name w/ SSN4
`INAME2`	First Name and Last Name
`INAME4`	Last Name and Street Address w/ SSN4
`INAME`	Last Name and Street Address
`IPHONEIADDR`	Phone Number w/ Input Street Address
`IPHONEISSN9`	Phone Number w/ Input SSN9
`IPHONE`	Phone Number
`ISKU`	SKU
`ISNAME`	Street Name
`ISNBR`	Street Number
`ISSN4`	SSN4
`ISSN9`	SSN9
`ISTRNZIP`	Street Name and ZIP Code
`IZIP`	ZIP Code
`LDOC`	Document Number
`LFIRST`	First Name
`LLAST`	Last Name
`LNAME4`	Last Name w/ SSN4
`LPHONE`	Phone Number
`LSAC`	Street Name and Unit Designation
`LSNAME`	Street Name
`LSNBR`	Street Number
`LSSN4`	SSN4
`LSSN9`	SSN9
`LZIP`	ZIP Code
`NAME2`	First Name and Last Name
`NAME4`	Last Name and Street Address w/ SSN4
`NAME`	Last Name and Street Address
`PHONE`	Phone Number
`SSN9`	SSN9
`STRNZIP`	Street Name and ZIP Code
`pass`	Pass
`fail`	Fail
`refer`	Refer

Trust USA result capabilities

Value	Description
`pass`	Pass
`fail`	Fail
`refer`	Refer

Default outcomes

Outcome	Condition	Description
`Verified`	Result includes `idphone.match`	The phone number is confirmed as associated with the identity.
`Not Verified`	Result includes `idphone.does.not.match` or risk includes `resultcode.invalid.phone.number`	The phone number does not match the identity, or the number itself is invalid.
`Could Not Locate`	Result includes `idphone.not.available`	No phone data could be found for the submitted number.
`ERROR`	Default (no conditions matched)	An unexpected error occurred.

Input payload

The following is a sample payload used to submit subject details to the US phone verification variant for processing.

JSON

{
  "resourceId": "<resourceId>",
  "context": {
    "config": {
      "delivery": "api"
    },
    "subject": {
      "identity": {
        "currentAddress": {
          "country": "US",
          "dependentLocality": "GA",
          "lines": [
            "1 SAMPLE STREET"
          ],
          "locality": "SAMPLETOWN",
          "postalCode": "12345"
        },
        "dateOfBirth": "1975-01-01",
        "emails": [
          {
            "email": "jane.doe@example.com",
            "type": "email"
          }
        ],
        "firstName": "Jane",
        "lastNames": [
          "Doe"
        ],
        "phones": [
          {
            "number": "2025550123",
            "type": "mobile"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`identity.firstName`	Yes	First name of the subject.
`identity.lastNames`	Yes	Array containing the last name(s) of the subject.
`identity.phones[].type`	Yes	Type of phone number (for example, `"mobile"`).
`identity.phones[].number`	Yes	Phone number of the subject.
`identity.dateOfBirth`	No	Date of birth in `YYYY-MM-DD` format.
`identity.emails[].type`	No	Type of email address (for example, `"email"`).
`identity.emails[].email`	No	Email address of the subject.
`identity.currentAddress.lines`	No	Array of address lines. Accepts up to 2 items.
`identity.currentAddress.locality`	No	Town or city.
`identity.currentAddress.dependentLocality`	No	State or region.
`identity.currentAddress.postalCode`	No	Postal or ZIP code.
`identity.currentAddress.country`	No	Country code (for example, `"US"`).

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {
      "n2p_result_capabilities": [],
      "n2p_risk_capabilities": [
        "resultcode.invalid.phone.number"
      ],
      "trust_usa_result_capabilities": [],
      "trust_usa_risk_capabilities": []
    },
    "outcome": "Not Verified"
  }
}

US mobile insights

Evaluates mobile account intelligence, checking the status, type, and recent change history of a mobile number to surface fraud signals. Requires the mobile phone; full name is optional.

Detail	Value
Required inputs	Mobile phone
Optional inputs	Full name

Capabilities

This variant returns the mobile account verification result alongside risk signals about the account’s status, type, and recent changes.

Result capabilities

Code	Label	Description
`mobile.attribute.verify.success`	Verify success	The mobile account attributes were successfully verified.
`mobile.attribute.verify.failure`	Verify failure	The mobile account attributes could not be verified.

Risk capabilities

Code	Label	Description
`resultcode.mobile.account.status.absent`	Account status absent	No account status data is available for this number.
`resultcode.mobile.account.status.active`	Account status active	The mobile account is active.
`resultcode.mobile.account.status.deactivated`	Account status deactivated	The mobile account has been deactivated.
`resultcode.mobile.account.status.suspended`	Account status suspended	The mobile account is suspended.
`resultcode.mobile.account.type.postpaid`	Account type postpaid	The account is a postpaid (contract) account.
`resultcode.mobile.account.type.prepaid`	Account type prepaid	The account is a prepaid account.
`resultcode.mobile.account.type.unknown`	Account type unknown	The account type could not be determined.
`resultcode.mobile.change.event.device`	Device change event	A device change was recently detected on this number.
`resultcode.mobile.change.event.number`	Number change event	A number change was recently detected.
`resultcode.mobile.change.event.ported`	Ported change event	The number was recently ported to a different carrier.
`resultcode.mobile.change.event.simswap`	SIM swap change event	A SIM swap was recently detected — a strong fraud indicator.
`resultcode.mobile.change.event.status`	Status change event	The account status recently changed.
`resultcode.mobile.service.not.available`	Service not available	The mobile insights service is unavailable.
`resultcode.mobile.id.age.alert`	Mobile ID age alert	The mobile identity age raises a concern.

Trust USA risk capabilities

Value	Description
`ADDR4`	Street Address w/ SSN4
`ADDR`	Street Address
`IADDR4`	Street Address w/ SSN4
`IADDR`	Street Address
`IALTADDR`	Alternate Street Address
`IALT`	Alternate Street Address
`IBADDR`	Business Address
`IBDBA`	Business DBA Name
`IBDBANAME`	Business DBA Name
`IBFEIN`	Business FEIN
`IBNAME`	Business Name
`IDOC`	Document Number
`IEMAILDOM`	Email Domain
`IEMAIL`	Email Address
`IEMAILIADDR`	Email Address w/ Input Street Address
`IEMAILIIPADDR`	Email Address w/ Input IP Address
`IEMAILIPHONE`	Email Address w/ Input Phone Number
`IEMAILISSN9`	Email Address w/ Input SSN9
`IFIRST`	First Name
`IIPADDRIADDR`	IP Address w/ Input Street Address
`IIPADDR`	IP Address
`IIPADDRIPHONE`	IP Address w/ Input Phone Number
`IIPADDRISSN9`	IP Address w/ Input SSN9
`IIP`	IP Address
`ILAST`	Last Name
`ILNAME4`	Last Name w/ SSN4
`INAME2`	First Name and Last Name
`INAME4`	Last Name and Street Address w/ SSN4
`INAME`	Last Name and Street Address
`IPHONEIADDR`	Phone Number w/ Input Street Address
`IPHONEISSN9`	Phone Number w/ Input SSN9
`IPHONE`	Phone Number
`ISKU`	SKU
`ISNAME`	Street Name
`ISNBR`	Street Number
`ISSN4`	SSN4
`ISSN9`	SSN9
`ISTRNZIP`	Street Name and ZIP Code
`IZIP`	ZIP Code
`LDOC`	Document Number
`LFIRST`	First Name
`LLAST`	Last Name
`LNAME4`	Last Name w/ SSN4
`LPHONE`	Phone Number
`LSAC`	Street Name and Unit Designation
`LSNAME`	Street Name
`LSNBR`	Street Number
`LSSN4`	SSN4
`LSSN9`	SSN9
`LZIP`	ZIP Code
`NAME2`	First Name and Last Name
`NAME4`	Last Name and Street Address w/ SSN4
`NAME`	Last Name and Street Address
`PHONE`	Phone Number
`SSN9`	SSN9
`STRNZIP`	Street Name and ZIP Code
`pass`	Pass
`fail`	Fail
`refer`	Refer

Trust USA result capabilities

Value	Description
`pass`	Pass
`fail`	Fail
`refer`	Refer

Default outcomes

Outcome	Condition	Description
`Caution`	Risk includes `resultcode.mobile.account.status.absent` or risk includes `resultcode.mobile.account.type.unknown`	Insufficient mobile account data to make a determination.
`Proceed`	Result includes `mobile.attribute.verify.success`	Mobile account attributes verified successfully.
`Fail`	Result includes `mobile.attribute.verify.failure`	Mobile account verification failed.
`ERROR`	Default (no conditions matched)	An unexpected error occurred.

Input payload

The following is a sample payload used to submit subject details to the US mobile insights variant for processing.

JSON

{
  "resourceId": "<resourceId>",
  "context": {
    "config": {
      "delivery": "api"
    },
    "subject": {
      "identity": {
        "currentAddress": {
          "country": "US",
          "dependentLocality": "GA",
          "lines": [
            "222333 PEACHTREE PLACE"
          ],
          "locality": "ATLANTA",
          "postalCode": "30318"
        },
        "dateOfBirth": "1975-02-28",
        "emails": [
          {
            "email": "joe@example.com",
            "type": "email"
          }
        ],
        "firstName": "Absent",
        "lastNames": [
          "Status"
        ],
        "phones": [
          {
            "number": "2025550123",
            "type": "phone"
          }
        ]
      }
    }
  }
}

Field	Required	Description
`identity.phones[].type`	Yes	Type of phone number (for example, `"phone"`).
`identity.phones[].number`	Yes	Phone number of the subject.
`identity.firstName`	No	First name of the subject.
`identity.lastNames`	No	Array containing the last name(s) of the subject.
`identity.dateOfBirth`	No	Date of birth in `YYYY-MM-DD` format.
`identity.emails[].type`	No	Type of email address (for example, `"email"`).
`identity.emails[].email`	No	Email address of the subject.
`identity.currentAddress.lines`	No	Array of address lines. Accepts up to 2 items.
`identity.currentAddress.locality`	No	Town or city.
`identity.currentAddress.dependentLocality`	No	State or region.
`identity.currentAddress.postalCode`	No	Postal or ZIP code.
`identity.currentAddress.country`	No	Country code (for example, `"US"`).

Sample response

The following is a sample response where insufficient mobile account data returned a Caution outcome.

JSON

{
  "response": {
    "advice": {
      "ma_result_capabilities": [
        "mobile.attribute.verify.success"
      ],
      "ma_risk_capabilities": [
        "resultcode.mobile.account.status.absent"
      ],
      "trust_usa_result_capabilities": [],
      "trust_usa_risk_capabilities": []
    },
    "outcome": "Caution"
  }
}

UK Mobile Identity Verification

Verifies identity data against UK mobile network records, returning field-level match flags with partial match support for name, date of birth, address, and mobile number.

Detail	Value
Required inputs	First name, last name, current address with country code, mobile phone
Optional inputs	Date of birth, middle names

Capabilities

This variant returns field-level match flags for each identity element checked against the mobile network record.

Name match flags

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.
Last names match result	Same values	Match result for the subject’s last name.

Address match flags

Capability	Values	Description
Current address overall match result	`match`, `mismatch`, `partial match`, `not available`, `unrecognised value`, `no result`	Overall address match result.
Building match result	Same values	Match result for the building number.
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.
Postal code match result	Same values	Match result for the postal code.

Other match flags

Capability	Values	Description
Date of birth match result	`match`, `mismatch`, `partial match`, `not available`, `unrecognised value`, `no result`	Match result for DOB.
Mobile phone match result	`match`, `mismatch`, `not available`, `unrecognised value`, `no result`	Whether the mobile number matched the identity record.

Default outcomes

partial match is accepted as a positive match for all fields.

Outcome	Condition	Description
`Identity Match`	First name is `match`/`partial match` and last name is `match`/`partial match` and DOB is `match`/`partial match` and address is `match`/`partial match`	All four elements confirmed.
`Partial Identity Match`	First name is `match`/`partial match` and last name is `match`/`partial match` and DOB or address is `match`/`partial match`	Name confirmed plus either DOB or address, but not all four.
`Could Not Locate`	First name is `not available` or mobile phone is `mismatch`	The identity could not be found, or the phone number itself mismatched.
`Identity Mismatch`	Default (no conditions matched)	The subject could not be verified.
`Error`	—	A system or data source error stopped the check from completing.

Input payload

The following is a sample payload used to submit subject details to the UK Mobile Identity Verification variant for processing.

JSON

{
  "resourceId": "<resourceId>",
  "context": {
    "config": {
      "delivery": "api"
    },
    "subject": {
      "identity": {
        "firstName": "John",
        "lastNames": ["Doe"],
        "dateOfBirth": "1990-03-26",
        "phones": [
          {
            "type": "mobile",
            "number": "+447700000000"
          }
        ],
        "currentAddress": {
          "premise": "0",
          "thoroughfare": "The Street",
          "locality": "Anyton",
          "postalCode": "AA1 1AA",
          "country": "GBR"
        }
      }
    }
  }
}

Field	Required	Description
`identity.firstName`	Yes	First name of the subject.
`identity.lastNames`	Yes	Array containing the last name(s) of the subject.
`identity.phones[].type`	Yes	Type of phone number. Must be `"mobile"`.
`identity.phones[].number`	Yes	Mobile number in international format (for example, `"+447700000000"`).
`identity.currentAddress.thoroughfare`	Yes	Street name.
`identity.currentAddress.locality`	Yes	Town or city.
`identity.currentAddress.postalCode`	Yes	Postal code.
`identity.currentAddress.country`	Yes	Three-letter country code (for example, `"GBR"`).
`identity.dateOfBirth`	No	Date of birth in `YYYY-MM-DD` format.
`identity.middleNames`	No	Array containing the subject’s middle name(s).
`identity.currentAddress.premise`	No	Property or building number.

Sample response

The following is a sample response where the subject could not be located in the mobile network records.

JSON

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

Germany Mobile Identity Verification

Verifies identity data against German mobile network records, returning field-level match flags for name, date of birth, address, and mobile number.

Detail	Value
Required inputs	First name, last name, current address with country code, mobile phone
Optional inputs	Date of birth, middle names

Default outcomes

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

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

Input payload

The following is a sample payload used to submit subject details to the Germany Mobile Identity Verification variant for processing.

JSON

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

Field	Required	Description
`identity.firstName`	Yes	First name of the subject.
`identity.lastNames`	Yes	Array containing the last name(s) of the subject.
`identity.phones[].type`	Yes	Type of phone number. Must be `"mobile"`.
`identity.phones[].number`	Yes	Mobile number in international format (for example, `"+447795111111"`).
`identity.currentAddress.thoroughfare`	Yes	Street name.
`identity.currentAddress.locality`	Yes	Town or city.
`identity.currentAddress.postalCode`	Yes	Postal code.
`identity.currentAddress.country`	Yes	Three-letter country code (for example, `"GBR"`).
`identity.dateOfBirth`	No	Date of birth in `YYYY-MM-DD` format.
`identity.middleNames`	No	Array containing the subject’s middle name(s).
`identity.currentAddress.premise`	No	Property or building number.

Sample response

The following is a sample response returned by the module.

JSON

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

France Mobile Identity Verification

Verifies identity data against French mobile network records, returning field-level match flags for name, date of birth, address, and mobile number.

Detail	Value
Required inputs	First name, last name, current address with country code, mobile phone
Optional inputs	Date of birth, middle names

Default outcomes

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

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

Input payload

The following is a sample payload used to submit subject details to the France Mobile Identity Verification variant for processing.

JSON

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

Field	Required	Description
`identity.firstName`	Yes	First name of the subject.
`identity.lastNames`	Yes	Array containing the last name(s) of the subject.
`identity.phones[].type`	Yes	Type of phone number. Must be `"mobile"`.
`identity.phones[].number`	Yes	Mobile number in international format (for example, `"+33612345678"`).
`identity.currentAddress.thoroughfare`	Yes	Street name.
`identity.currentAddress.locality`	Yes	Town or city.
`identity.currentAddress.postalCode`	Yes	Postal code.
`identity.currentAddress.country`	Yes	Three-letter country code (for example, `"FRA"`).
`identity.dateOfBirth`	No	Date of birth in `YYYY-MM-DD` format.
`identity.middleNames`	No	Array containing the subject’s middle name(s).
`identity.currentAddress.premise`	No	Property or building number.

Sample response

The following is a sample response returned by the module.

JSON

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

Spain Mobile Identity Verification

Verifies identity data against Spanish mobile network records, returning field-level match flags for name, date of birth, address, and mobile number.

Detail	Value
Required inputs	First name, last name, current address with country code, mobile phone
Optional inputs	Date of birth, middle names

Default outcomes

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

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

Input payload

The following is a sample payload used to submit subject details to the Spain Mobile Identity Verification variant for processing.

JSON

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

Field	Required	Description
`identity.firstName`	Yes	First name of the subject.
`identity.lastNames`	Yes	Array containing the last name(s) of the subject.
`identity.phones[].type`	Yes	Type of phone number. Must be `"mobile"`.
`identity.phones[].number`	Yes	Mobile number in international format (for example, `"+34612345678"`).
`identity.currentAddress.thoroughfare`	Yes	Street name.
`identity.currentAddress.locality`	Yes	Town or city.
`identity.currentAddress.postalCode`	Yes	Postal code.
`identity.currentAddress.country`	Yes	Three-letter country code (for example, `"ESP"`).
`identity.dateOfBirth`	No	Date of birth in `YYYY-MM-DD` format.
`identity.middleNames`	No	Array containing the subject’s middle name(s).
`identity.currentAddress.premise`	No	Property or building number.

Sample response

The following is a sample response returned by the module.

JSON

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

Canada Mobile Identity Verification

Verifies identity data against Canadian mobile network records, returning field-level match flags for name, date of birth, address, and mobile number.

Detail	Value
Required inputs	First name, last name, current address with country code, mobile phone
Optional inputs	Date of birth, middle names

Additional capability

Capability	Values	Description
Market segment	`PAYG`, `PAYM`, `Business`, `n/a`, `no result`	The account type associated with the mobile number. `PAYG` = pay-as-you-go, `PAYM` = contract. Not used in default outcomes.

Default outcomes

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

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

Input payload

The following is a sample payload used to submit subject details to the Canada Mobile Identity Verification variant for processing.

JSON

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

Field	Required	Description
`identity.firstName`	Yes	First name of the subject.
`identity.lastNames`	Yes	Array containing the last name(s) of the subject.
`identity.phones[].type`	Yes	Type of phone number. Must be `"mobile"`.
`identity.phones[].number`	Yes	Mobile number in international format (for example, `"+14165551234"`).
`identity.currentAddress.thoroughfare`	Yes	Street name.
`identity.currentAddress.locality`	Yes	Town or city.
`identity.currentAddress.postalCode`	Yes	Postal code.
`identity.currentAddress.country`	Yes	Three-letter country code (for example, `"CAN"`).
`identity.dateOfBirth`	No	Date of birth in `YYYY-MM-DD` format.
`identity.middleNames`	No	Array containing the subject’s middle name(s).
`identity.currentAddress.premise`	No	Property or building number.

Sample response

The following is a sample response returned by the module.

JSON

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

UK Mobile Fraud Verification

TMT Verify Fraud Indicators (Sim Swap + Call Forwarding)

Detail	Value
Required inputs	Mobile phone in international format, current address with country code only

Capabilities

This variant returns SIM swap detection signals alongside a phone match result and call forwarding status.

SIM swap detection

Capability	Type	Values	Description
SIM swap found	Enum	`Y`, `N`, `no result`	Whether a SIM swap has occurred.
SIM swapped in last 24 hours	Enum	`Y`, `N`, `no result`	Whether a SIM swap occurred in the last 24 hours.
SIM swap max days	Enum	`24`, `72`, `720`, `no result`	Maximum days since the last SIM swap. `24` = last day, `72` = last 3 days, `720` = last 30 days.
Days since SIM swap	Integer	0–366	Exact number of days since the last SIM swap, when known.
The number of days since the last SIM swap (when known) is present	Boolean	`true`, `false`	Whether the days-since-SIM-swap value is available. Defaults to `false`.

Other capabilities

Capability	Type	Values	Description
Mobile phone match result	Enum	`match`, `mismatch`, `not available`, `unrecognised value`, `no result`	Whether the mobile number was found in the network.
Call forwarding	Enum	`Y`, `N`, `no result`	Whether call forwarding is active on the number.

Default outcomes

The default outcome is Low Risk, meaning no fraud signals were detected.

Outcome	Condition	Description
`Could Not Locate`	Mobile phone is `mismatch`	The mobile number could not be found in the network.
`High Risk`	SIM swap is `Y` and SIM swap max days is `24` or `72`, or call forwarding is `Y`	A SIM swap within the last 3 days, or active call forwarding, was detected.
`Medium Risk`	SIM swap is `Y` and SIM swap max days is `720`	A SIM swap occurred within the last 30 days but not in the last 3 days.
`Low Risk`	Default (no conditions matched)	No SIM swap or call forwarding activity detected.
`Error`	—	A system or data source error stopped the check from completing.

Input payload

The following is a sample payload used to submit a mobile number to the UK Mobile Fraud Verification variant for processing. This variant needs only a mobile number and a country code. No identity data is required.

JSON

{
  "resourceId": "<resourceId>",
  "context": {
    "config": {
      "delivery": "api"
    },
    "subject": {
      "identity": {
        "phones": [
          {
            "type": "mobile",
            "number": "+447700000000"
          }
        ],
        "currentAddress": {
          "country": "GBR"
        }
      }
    }
  }
}

Field	Required	Description
`identity.phones[].type`	Yes	Type of phone number. Must be `"mobile"`.
`identity.phones[].number`	Yes	Mobile number in international format (for example, `"+447700000000"`).
`identity.currentAddress.country`	Yes	Three-letter country code (for example, `"GBR"`).

Sample response

The following is a sample response where fraud signals returned a High Risk outcome.

JSON

{
  "response": {
    "advice": {
      "contains": {}
    },
    "outcome": "High Risk"
  }
}

Germany Mobile Fraud Verification

TMT Verify Fraud Indicators (Sim Swap + Call Forwarding)

Detail	Value
Required inputs	Mobile phone in international format, current address with country code only

Default outcomes

Outcome	Condition	Description
`Could Not Locate`	Mobile phone is `mismatch`	The mobile number could not be found in the network.
`High Risk`	SIM swap is `Y` and SIM swap max days is `24` or `72`	A SIM swap within the last 3 days was detected.
`Medium Risk`	SIM swap is `Y` and SIM swap max days is `720`	A SIM swap occurred within the last 30 days but not in the last 3 days.
`Low Risk`	Default (no conditions matched)	No SIM swap activity detected.
`Error`	—	A system or data source error stopped the check from completing.

Input payload

The following is a sample payload used to submit a mobile number to the Germany Mobile Fraud Verification variant for processing. This variant needs only a mobile number and a country code. No identity data is required.

JSON

{
  "resourceId": "<resourceId>",
  "context": {
    "config": {
      "delivery": "api"
    },
    "subject": {
      "identity": {
        "phones": [
          {
            "type": "mobile",
            "number": "+447795111111"
          }
        ],
        "currentAddress": {
          "country": "GBR"
        }
      }
    }
  }
}

Field	Required	Description
`identity.phones[].type`	Yes	Type of phone number. Must be `"mobile"`.
`identity.phones[].number`	Yes	Mobile number in international format (for example, `"+447795111111"`).
`identity.currentAddress.country`	Yes	Three-letter country code (for example, `"GBR"`).

Sample response

The following is a sample response where no fraud signals returned a Low Risk outcome.

JSON

{
  "response": {
    "advice": {
      "contains": {}
    },
    "outcome": "Low Risk"
  }
}

France Mobile Fraud Verification

TMT Verify Fraud Indicators (Sim Swap + Call Forwarding)

Detail	Value
Required inputs	Mobile phone in international format, current address with country code only

Input payload

The following is a sample payload used to submit a mobile number to the France Mobile Fraud Verification variant for processing. This variant needs only a mobile number and a country code. No identity data is required.

JSON

{
  "resourceId": "<resourceId>",
  "context": {
    "config": {
      "delivery": "api"
    },
    "subject": {
      "identity": {
        "phones": [
          {
            "type": "mobile",
            "number": "+33612345678"
          }
        ],
        "currentAddress": {
          "country": "FRA"
        }
      }
    }
  }
}

Field	Required	Description
`identity.phones[].type`	Yes	Type of phone number. Must be `"mobile"`.
`identity.phones[].number`	Yes	Mobile number in international format (for example, `"+33612345678"`).
`identity.currentAddress.country`	Yes	Three-letter country code (for example, `"FRA"`).

Sample response

The following is a sample response where no fraud signals returned a Low Risk outcome.

JSON

{
  "response": {
    "advice": {
      "contains": {}
    },
    "outcome": "Low Risk"
  }
}

Spain Mobile Fraud Verification

TMT Verify Fraud Indicators (Sim Swap + Call Forwarding)

Detail	Value
Required inputs	Mobile phone in international format, current address with country code only

Input payload

The following is a sample payload used to submit a mobile number to the Spain Mobile Fraud Verification variant for processing. This variant needs only a mobile number and a country code. No identity data is required.

JSON

{
  "resourceId": "<resourceId>",
  "context": {
    "config": {
      "delivery": "api"
    },
    "subject": {
      "identity": {
        "phones": [
          {
            "type": "mobile",
            "number": "+34612345678"
          }
        ],
        "currentAddress": {
          "country": "ESP"
        }
      }
    }
  }
}

Field	Required	Description
`identity.phones[].type`	Yes	Type of phone number. Must be `"mobile"`.
`identity.phones[].number`	Yes	Mobile number in international format (for example, `"+34612345678"`).
`identity.currentAddress.country`	Yes	Three-letter country code (for example, `"ESP"`).

Sample response

The following is a sample response where no fraud signals returned a Low Risk outcome.

JSON

{
  "response": {
    "advice": {
      "contains": {}
    },
    "outcome": "Low Risk"
  }
}

Canada Mobile Fraud Verification

TMT Verify Fraud Indicators (Sim Swap + Call Forwarding)

Detail	Value
Required inputs	Mobile phone in international format, current address with country code only

Input payload

The following is a sample payload used to submit a mobile number to the Canada Mobile Fraud Verification variant for processing. This variant needs only a mobile number and a country code. No identity data is required.

JSON

{
  "resourceId": "<resourceId>",
  "context": {
    "config": {
      "delivery": "api"
    },
    "subject": {
      "identity": {
        "phones": [
          {
            "type": "mobile",
            "number": "+12025550123"
          }
        ],
        "currentAddress": {
          "country": "CAN"
        }
      }
    }
  }
}

Field	Required	Description
`identity.phones[].type`	Yes	Type of phone number. Must be `"mobile"`.
`identity.phones[].number`	Yes	Mobile number in international format (for example, `"+14165551234"`).
`identity.currentAddress.country`	Yes	Three-letter country code (for example, `"CAN"`).

Sample response

The following is a sample response where no fraud signals returned a Low Risk outcome.

JSON

{
  "response": {
    "advice": {
      "contains": {}
    },
    "outcome": "Low Risk"
  }
}

Global Mobile Validation

Capabilities

Mobile phone match result

Indicates if the phone number has matched

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

Input payload

The following is a sample payload used to submit data to the Global Mobile Validation module for processing.

JSON

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

Field	Required	Description
`MobilePhone`	Yes	The subject’s mobile telephone number.

Sample response

The following is a sample response returned by the module.

JSON

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

​Capabilities

​Result capabilities

​Risk capabilities

​Trust USA risk capabilities

​Trust USA result capabilities

​Default outcomes

​Input payload

​Sample response

​Capabilities

​Result capabilities

​Risk capabilities

​Trust USA risk capabilities

​Trust USA result capabilities

​Default outcomes

​Input payload

​Sample response

​Capabilities

​Name match flags

​Address match flags

​Other match flags

​Default outcomes

​Input payload

​Sample response

​Default outcomes

​Input payload

​Sample response

​Default outcomes

​Input payload

​Sample response

​Default outcomes

​Input payload

​Sample response

​Additional capability

​Default outcomes

​Input payload

​Sample response

​Capabilities

​SIM swap detection

​Other capabilities

​Default outcomes

​Input payload

​Sample response

​Default outcomes

​Input payload

​Sample response

​Input payload

​Sample response

​Input payload

​Sample response

​Input payload

​Sample response

​Capabilities

​Mobile phone match result

​Input payload

​Sample response

Capabilities

Result capabilities

Risk capabilities

Trust USA risk capabilities

Trust USA result capabilities

Default outcomes

Input payload

Sample response

Capabilities

Result capabilities

Risk capabilities

Trust USA risk capabilities

Trust USA result capabilities

Default outcomes

Input payload

Sample response

Capabilities

Name match flags

Address match flags

Other match flags

Default outcomes

Input payload

Sample response

Default outcomes

Input payload

Sample response

Default outcomes

Input payload

Sample response

Default outcomes

Input payload

Sample response

Additional capability

Default outcomes

Input payload

Sample response

Capabilities

SIM swap detection

Other capabilities

Default outcomes

Input payload

Sample response

Default outcomes

Input payload

Sample response

Input payload

Sample response

Input payload

Sample response

Input payload

Sample response

Capabilities

Mobile phone match result

Input payload

Sample response