Skip to main content

AML For Address integration

To intiate an address aml screening, make HTTP POST request to:

/api/v2/address

Request headers:

Content-Type: application/json

Request body:

PropertyDescription
addressStreet address
cityCity (optional)
postalCodePostal or Zip code (optional)
stateState (optional) (applicable for USA and Canada)
countryCodeISO 3166-1 alpha-3 compliant country code (optional)
externalIdYour internal identifier to be set on the screening. (optional)
Example request
curl -X 'POST' 'https://screenings-api-test.globalpass.ch/api/v2/address' -H 'accept: text/plain' -H 'Authorization: Bearer {your_access_token}'-H 'Content-Type: application/json' -d '{ "address": "Gran Subida Mario, 7", "city": "Málaga", "countryCode": "ESP", "postalCode": "37764", "externalId": "AAA111" }'
Example response
{
"token": "f4564d3d-69de-4093-971d-796699c0e8c5"
}