Download OpenAPI specification:Download
Acxiom DaaS API
Composite V3
tenant | string Tenant ID for the user (used for authorization). If the user is not mapped to a single tenant and role, this needs to be specified. |
role | string Role for the user (used for authorization). If the user is not mapped to a single tenant and role, this needs to be specified. |
DaaS Composite
object (Access Control) | |
object or object | |
object (Match Control) | |
Data Control (object) or Data Control (object) (Data Control) | |
Array of objects (Composite Detail Input) non-empty |
{- "accessControl": {
- "role": "string",
- "tenantId": "string",
- "coaAuthId": "string"
}, - "hygieneControl": {
- "global": {
- "general": {
- "nameAddressPreclean": "Null - No name address pre-clean is performed\nField - Field level cleaning\nWord - Word level cleaning",
- "casing": "Upper",
- "bestOfBreedHygiene": true,
- "transliterate": false,
- "dropProfanity": false
}, - "name": {
- "nameHygiene": false,
- "reparseName": false,
- "includePrefixAndSuffixInOutputName": false,
- "inferTitle": false,
- "inferGender": "name"
}, - "address": {
- "postalHygiene": true,
- "forceCountryCode": "USA, CAN, GBR, DEU",
- "defaultCountryCode": "USA, CAN, GBR, DEU",
- "countryIdentification": "False - no matching is done\nTrue - Service returns best single country match\nMulti - Service returns the three best matches for country (to\n get multiple outputs, the proper value needs to be put in Data \nAppend Settings tab too). If Country ID returns two potential \nmatches, such as Paris, Arkansas (USA) at 30 percent, and \nParis, France at 60 percent, both countries could be passed \nto Address Hygiene.\nIf you pass anything other than the three options above you'll get \nfalse as a value because it won't recognize anything other than \nthe three above.",
- "countryCharacterEncoding": false,
- "ignoreChangeOfAddressErrors": false,
- "addressProcessingMode": "Null - left blank - processing will not occur.\nE - Default - Either Town or Locality required\nN - Neither Town nor Locality required\nB - Both Town and Locality required",
- "identifyAddress": false,
- "identifyName": false,
- "identifyBusiness": false
}, - "phone": {
- "defaultInternationalDirectDialingCode": "Null - default - if left null the default code is 011.\n<numeric IDD code>",
- "defaultInternationalCarrierCode": "Null - default - if no carrier code is being used or no value \nis populated.\n<numeric ICC code>"
}, - "email": {
- "emailHygiene": false,
- "multibyteEmails": false
}
}, - "us": {
- "general": {
- "dropProfanity": false
}, - "name": {
- "nameHygiene": false,
- "inputNameCorrection": false,
- "inputNameDefaultFormat": "firstNameFirst"
}, - "address": {
- "postalHygiene": true,
- "identifyBusiness": false,
- "identifyCityStateZip": false,
- "identifyName": false,
- "identifyAddress": false,
- "identifyTitle": false,
- "favorNonStreetPrimaryAddress": false
}, - "email": {
- "emailHygiene": false,
- "multibyteEmails": false
}
}
}, - "matchControl": {
- "matchLevel": "strict, default",
- "strictValidation": "true (default), false"
}, - "dataControl": {
- "userBundle": "string",
- "bundles": "string",
- "geoCoderLevel": "default"
}, - "data": [
- {
- "name": {
- "parsedUS": {
- "namePrefix": "string",
- "first": "john, mary, ...",
- "middle": "w, william, b, beth, ...",
- "last": "smith, jones, ...",
- "generationalSuffix": "jr, sr, iii, iv (more details)"
}, - "parsedGlobal": {
- "prefix": "string",
- "first": "string",
- "middle": "string",
- "otherMiddle": "string",
- "lastPrefix": "string",
- "last": "string",
- "generationalSuffix": "string",
- "maiden": "string",
- "matronymic": "string",
- "patronymic": "string",
- "suffixOther": "string"
}, - "unparsed": "string",
- "business": "string"
}, - "address": {
- "parsedUS": {
- "streetInfo": {
- "primaryNumber": " 10, 123, 3333, ...",
- "preDirectional": " n, s, e, w, ...",
- "street": "main, finley, hillsdale, ...",
- "streetSuffix": "st, dr, rd, blvd, ...",
- "postDirectional": "n, s, e, w, ...",
- "unitDesignator": "apt, ste, fl, ...",
- "secondaryNumber": " 12A, 4, .."
}, - "city": "downers grove, foster city, shoreview, ...",
- "state": "ca, tn, il, ar, co, ...",
- "zipCode": "12345, 60515, 72201, ...",
- "urbanizationName": "SAN PEDRO"
}, - "parsedGlobal": {
- "building": "string",
- "subBuilding": "string",
- "postBox": "string",
- "premise": "string",
- "thoroughfare": "string",
- "dependentThoroughfare": "string",
- "locality": "string",
- "dependentLocality": "string",
- "doubleDependentLocality": "string",
- "administrativeArea": "string",
- "subAdministrativeArea": "string",
- "superAdministrativeArea": "string",
- "postalCode": "string",
- "country": "United States, Brazil, Germany",
- "countryCode": "string",
- "countryLocaleInfo": "string"
}, - "unparsedUS": {
- "lines": [
- "101 w main st s apt 12"
], - "city": "downers grove, foster city, shoreview, ...",
- "state": "ca, tn, il, ar, co, ...",
- "zipCode": "12345, 60515, 72201, ..."
}, - "unparsedGlobal": {
- "lines": [
- "string"
], - "locality": "string",
- "administrativeArea": "string",
- "postalCode": "string",
- "country": "string",
- "countryCode": "string",
- "countryLocaleInfo": "string"
}
}, - "email": {
- "address": "john.smith@somedomain.com",
- "md5": "103e9f125b238a634906fc4c0ac345c9"
}, - "phones": [
- {
- "parsedUS": {
- "areaCode": "630",
- "exchange": "555",
- "subscriberNumber": "8052"
}, - "unparsedNumber": "string"
}
], - "geo": {
- "latitude": "41.824452",
- "longitude": "-88.02464"
}, - "associativeData": {
- "sumLastFourSSN": "9137 sums up to 20 \n(9+1+3+7=20)",
- "yearOfBirth": "1973, 1981, 1997"
}, - "customData": {
- "property1": "string",
- "property2": "string"
}, - "clientReference": "string"
}
]
}
[- {
- "clientReferenceId": "string",
- "code": "string"
}
]