Simulate Address Validation
Overview
test with dummy data
Do not enter production data in the Test environment. The Highnote Test environment is for exploring features and training. Use only dummy or test data.
Before submitting a physical card order, you can validate the card order's shipping address to ensure it is properly formatted and CASS-certified. For more information on shipping address validation, see Validate shipping address.
Highnote provides a simulation for validating a shipping address in the Test environment. This simulation can be used to test your card product's physical card order flow and notification events.
This guide provides steps for simulating shipping address validation for card orders.
Prerequisites
- A Highnote account
- An API key or the API Explorer
- An individual card order or group card order
Simulate valid address
Use the following mutation to simulate a successful address validation:
validateAddress
Query
mutation validateAddress($input: ValidateAddressInput!) {
validateAddress(input: $input) {
__typename
... on AddressValidationResult {
outcome {
... on AddressInvalidResult {
__typename
componentsInvalid
provided {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
}
... on AddressIncompleteResult {
__typename
componentsMissing
provided {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
}
... on AddressValidatedWithChangesResult {
__typename
componentsChanged
token {
id
provided {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
standardized {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
labels
createdAt
}
}
... on AddressValidatedResult {
__typename
token {
id
provided {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
standardized {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
labels
createdAt
}
}
}
}
... on UserError {
errors {
errorPath
code
}
}
}
}
Variables
{ "input": { "idempotencyKey": "IDEMPOTENCY-KEY", "address": { "streetAddress": "24 Willie Mays Plz", "locality": "San Francisco", "region": "CA", "postalCode": "94107-2134", "countryCodeAlpha3": "USA" } } }
⚠️ Please login to execute queries. Visit the dashboard to authenticate.
Result
{
"data": {
"validateAddress": {
"__typename": "AddressValidationResult",
"outcome": {
"__typename": "AddressValidatedResult",
"token": {
"id": "ADDRESS_TOKEN_ID",
"provided": {
"streetAddress": "24 Willie Mays Plz",
"extendedAddress": "",
"locality": "San Francisco",
"region": "CA",
"postalCode": "94107-2134",
"countryCodeAlpha3": "USA"
},
"standardized": {
"streetAddress": "24 WILLIE MAYS PLZ",
"extendedAddress": "",
"locality": "SAN FRANCISCO",
"region": "CA",
"postalCode": "94107-2134",
"countryCodeAlpha3": "USA"
},
"labels": [
"BUSINESS"
],
"createdAt": "2024-06-18T17:23:46.591Z"
}
}
}
},
"extensions": {
"requestId": "REQUEST_ID",
"rateLimit": {
"cost": 14
}
}
}
Simulate address with changes
You can simulate an address with changes response by using the keyword changed in the streetAddress field of an address validation query.
Use the following mutation to simulate an AddressValidatedWithChangesResult response:
validateAddress
Query
mutation validateAddress($input: ValidateAddressInput!) {
validateAddress(input: $input) {
__typename
... on AddressValidationResult {
outcome {
... on AddressInvalidResult {
__typename
componentsInvalid
provided {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
}
... on AddressIncompleteResult {
__typename
componentsMissing
provided {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
}
... on AddressValidatedWithChangesResult {
__typename
componentsChanged
token {
id
provided {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
standardized {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
labels
createdAt
}
}
... on AddressValidatedResult {
__typename
token {
id
provided {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
standardized {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
labels
createdAt
}
}
}
}
... on UserError {
errors {
errorPath
code
}
}
}
}
Variables
{ "input": { "idempotencyKey": "IDEMPOTENCY-KEY", "address": { "streetAddress": "changed", "locality": "San Francisco", "region": "CA", "postalCode": "94107-2134", "countryCodeAlpha3": "USA" } } }
⚠️ Please login to execute queries. Visit the dashboard to authenticate.
Result
{
"data": {
"validateAddress": {
"__typename": "AddressValidationResult",
"outcome": {
"__typename": "AddressValidatedWithChangesResult",
"componentsChanged": [
"STREET_ADDRESS",
"POSTAL_CODE"
],
"token": {
"id": "tkvad_rumdbwu76mxjnp14rhai9k2a5",
"provided": {
"streetAddress": "changed",
"extendedAddress": "",
"locality": "San Francisco",
"region": "CA",
"postalCode": "94107",
"countryCodeAlpha3": "USA"
},
"standardized": {
"streetAddress": "24 WILLIE MAYS PLZ",
"extendedAddress": "",
"locality": "SAN FRANCISCO",
"region": "CA",
"postalCode": "94107-2134",
"countryCodeAlpha3": "USA"
},
"labels": [
"BUSINESS"
]
}
}
}
},
"extensions": {
"requestId": "b3b86ea0-fcaf-98d7-abe8-fa12660d8049",
"rateLimit": {
"cost": 14
}
}
}
Simulate incomplete address
You can simulate an incomplete address response by using the keyword incomplete in the streetAddress field of an address validation query.
Use the following mutation to simulate an AddressIncompleteResult response:
validateAddress
Query
mutation validateAddress($input: ValidateAddressInput!) {
validateAddress(input: $input) {
__typename
... on AddressValidationResult {
outcome {
... on AddressInvalidResult {
__typename
componentsInvalid
provided {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
}
... on AddressIncompleteResult {
__typename
componentsMissing
provided {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
}
... on AddressValidatedWithChangesResult {
__typename
componentsChanged
token {
id
provided {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
standardized {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
labels
createdAt
}
}
... on AddressValidatedResult {
__typename
token {
id
provided {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
standardized {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
labels
createdAt
}
}
}
}
... on UserError {
errors {
errorPath
code
}
}
}
}
Variables
{ "input": { "idempotencyKey": "IDEMPOTENCY-KEY", "address": { "streetAddress": "changed", "locality": "San Francisco", "region": "CA", "postalCode": "94107-2134", "countryCodeAlpha3": "USA" } } }
⚠️ Please login to execute queries. Visit the dashboard to authenticate.
Result
{
"data": {
"validateAddress": {
"__typename": "AddressValidationResult",
"outcome": {
"__typename": "AddressValidatedWithChangesResult",
"componentsChanged": [
"STREET_ADDRESS",
"POSTAL_CODE"
],
"token": {
"id": "tkvad_rumdbwu76mxjnp14rhai9k2a5",
"provided": {
"streetAddress": "changed",
"extendedAddress": "",
"locality": "San Francisco",
"region": "CA",
"postalCode": "94107",
"countryCodeAlpha3": "USA"
},
"standardized": {
"streetAddress": "24 WILLIE MAYS PLZ",
"extendedAddress": "",
"locality": "SAN FRANCISCO",
"region": "CA",
"postalCode": "94107-2134",
"countryCodeAlpha3": "USA"
},
"labels": [
"BUSINESS"
]
}
}
}
},
"extensions": {
"requestId": "b3b86ea0-fcaf-98d7-abe8-fa12660d8049",
"rateLimit": {
"cost": 14
}
}
}
Simulate invalid address
You can simulate an invalid address response by using the keyword invalid in the streetAddress field of an address validation query.
Use the following mutation to simulate an AddressInvalidResult response:
validateAddress
Query
mutation validateAddress($input: ValidateAddressInput!) {
validateAddress(input: $input) {
__typename
... on AddressValidationResult {
outcome {
... on AddressInvalidResult {
__typename
componentsInvalid
provided {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
}
... on AddressIncompleteResult {
__typename
componentsMissing
provided {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
}
... on AddressValidatedWithChangesResult {
__typename
componentsChanged
token {
id
provided {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
standardized {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
labels
createdAt
}
}
... on AddressValidatedResult {
__typename
token {
id
provided {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
standardized {
streetAddress
extendedAddress
locality
region
postalCode
countryCodeAlpha3
}
labels
createdAt
}
}
}
}
... on UserError {
errors {
errorPath
code
}
}
}
}
Variables
{ "input": { "idempotencyKey": "IDEMPOTENCY-KEY", "address": { "streetAddress": "invalid", "locality": "San Francisco", "region": "CA", "postalCode": "94107-2134", "countryCodeAlpha3": "USA" } } }
⚠️ Please login to execute queries. Visit the dashboard to authenticate.
Result
{
"data": {
"validateAddress": {
"__typename": "AddressValidationResult",
"outcome": {
"__typename": "AddressInvalidResult",
"componentsInvalid": [
"STREET_ADDRESS"
],
"provided": {
"streetAddress": "invalid",
"extendedAddress": "",
"locality": "San Francisco",
"region": "CA",
"postalCode": "94107-2134",
"countryCodeAlpha3": "USA"
}
}
}
},
"extensions": {
"requestId": "7d078e74-7e17-9a0a-a3e3-2ef053deec75",
"rateLimit": {
"cost": 14
}
}
}