Step 2: Map Name & Address Fields
Purpose: Get a detailed list of fields that must be sent in a request to verify an identity for a given country. This is the Name and Address information UtilityID will be verifying.
User-experience: Use this endpoint to see what information you need to collect from your end-users.
Sample Request
GET /configuration/v1/fields/Identity Verification/{countryCode} HTTP/1.1
Host: <<endpoint>>
Authorization: Basic <AUTH>
Parameters:
- countryCode - country for which providers need to be retrieved.
- Required
- Type: string
Sample Response
{
"title": "DataFields",
"type": "object",
"properties": {
"PersonInfo": {
"title": "PersonInfo",
"type": "object",
"properties": {
"FirstGivenName": {
"type": "string",
"description": "First name of the individual to be verified",
"label": "First Name"
},
"FirstSurName": {
"type": "string",
"description": "Last name of the individual to be verified",
"label": "Last Name"
}
},
"required": [
"FirstGivenName",
"FirstSurName"
]
},
"Location": {
"title": "Location",
"type": "object",
"properties": {
"City": {
"type": "string",
"description": "Municipality of primary address of the individual to be verified",
"label": "Municipality"
},
"StateProvinceCode": {
"type": "string",
"description": "Province of home address",
"label": "Province"
},
"PostalCode": {
"type": "string",
"description": "ZIP Code or Postal Code of primary residence",
"label": "Postal Code"
},
"AdditionalFields": {
"type": "object",
"description": "Street address of primary residence",
"label": "Address 1",
"properties": {
"title": "AdditionalFields",
"type": "object",
"properties": {
"Address1": {
"type": "string",
"description": "Street address of primary residence",
"label": "Address 1"
}
},
"required": [
"Address1"
]
}
}
},
"required": [
"AdditionalFields",
"City",
"PostalCode",
"StateProvinceCode"
]
}
}
}
Updated over 1 year ago