POST api/EquifaxAML

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
url	string	None.
clientId	string	None.
clientSecret	string	None.
requestReference	string	None.
proposalNumber	string	None.
primaryPerson	AMLRequestPerson	None.
secondaryPerson	AMLRequestPerson	None.

Request Formats

application/json, text/json

Sample:

{
  "url": "sample string 1",
  "clientId": "sample string 2",
  "clientSecret": "sample string 3",
  "requestReference": "sample string 4",
  "proposalNumber": "sample string 5",
  "primaryPerson": {
    "personId": "sample string 1",
    "title": "sample string 2",
    "forename": "sample string 3",
    "middlename": "sample string 4",
    "surname": "sample string 5",
    "dateOfBirth": "2025-10-25T11:05:23.8809381+01:00",
    "nationality": "sample string 7",
    "address": {
      "name": "sample string 1",
      "number": "sample string 2",
      "address1": "sample string 3",
      "address2": "sample string 4",
      "locality": "sample string 5",
      "town": "sample string 6",
      "county": "sample string 7",
      "postcode": "sample string 8",
      "country": "sample string 9"
    }
  },
  "secondaryPerson": {
    "personId": "sample string 1",
    "title": "sample string 2",
    "forename": "sample string 3",
    "middlename": "sample string 4",
    "surname": "sample string 5",
    "dateOfBirth": "2025-10-25T11:05:23.8809381+01:00",
    "nationality": "sample string 7",
    "address": {
      "name": "sample string 1",
      "number": "sample string 2",
      "address1": "sample string 3",
      "address2": "sample string 4",
      "locality": "sample string 5",
      "town": "sample string 6",
      "county": "sample string 7",
      "postcode": "sample string 8",
      "country": "sample string 9"
    }
  }
}

application/xml, text/xml

Sample:

<AMLRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EquifaxAPI.Models.AML">
  <primaryPerson xmlns="http://schemas.datacontract.org/2004/07/EquifaxConnector.AML">
    <address xmlns:d3p1="http://schemas.datacontract.org/2004/07/EquifaxConnector">
      <d3p1:address1>sample string 3</d3p1:address1>
      <d3p1:address2>sample string 4</d3p1:address2>
      <d3p1:country>sample string 9</d3p1:country>
      <d3p1:county>sample string 7</d3p1:county>
      <d3p1:locality>sample string 5</d3p1:locality>
      <d3p1:name>sample string 1</d3p1:name>
      <d3p1:number>sample string 2</d3p1:number>
      <d3p1:postcode>sample string 8</d3p1:postcode>
      <d3p1:town>sample string 6</d3p1:town>
    </address>
    <dateOfBirth>2025-10-25T11:05:23.8809381+01:00</dateOfBirth>
    <forename>sample string 3</forename>
    <middlename>sample string 4</middlename>
    <nationality>sample string 7</nationality>
    <personId>sample string 1</personId>
    <surname>sample string 5</surname>
    <title>sample string 2</title>
  </primaryPerson>
  <proposalNumber xmlns="http://schemas.datacontract.org/2004/07/EquifaxConnector.AML">sample string 5</proposalNumber>
  <requestReference xmlns="http://schemas.datacontract.org/2004/07/EquifaxConnector.AML">sample string 4</requestReference>
  <secondaryPerson xmlns="http://schemas.datacontract.org/2004/07/EquifaxConnector.AML">
    <address xmlns:d3p1="http://schemas.datacontract.org/2004/07/EquifaxConnector">
      <d3p1:address1>sample string 3</d3p1:address1>
      <d3p1:address2>sample string 4</d3p1:address2>
      <d3p1:country>sample string 9</d3p1:country>
      <d3p1:county>sample string 7</d3p1:county>
      <d3p1:locality>sample string 5</d3p1:locality>
      <d3p1:name>sample string 1</d3p1:name>
      <d3p1:number>sample string 2</d3p1:number>
      <d3p1:postcode>sample string 8</d3p1:postcode>
      <d3p1:town>sample string 6</d3p1:town>
    </address>
    <dateOfBirth>2025-10-25T11:05:23.8809381+01:00</dateOfBirth>
    <forename>sample string 3</forename>
    <middlename>sample string 4</middlename>
    <nationality>sample string 7</nationality>
    <personId>sample string 1</personId>
    <surname>sample string 5</surname>
    <title>sample string 2</title>
  </secondaryPerson>
  <clientId>sample string 2</clientId>
  <clientSecret>sample string 3</clientSecret>
  <url>sample string 1</url>
</AMLRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AMLResponse

Name	Type	Additional information
requestReference	string	None.
proposalNumber	string	None.
primaryPerson	AMLResponsePerson	None.
secondaryPerson	AMLResponsePerson	None.
attributes	Collection of AMLResponseAttribute	None.

Response Formats

application/json, text/json

Sample:

{
  "requestReference": "sample string 1",
  "proposalNumber": "sample string 2",
  "primaryPerson": {
    "personId": "sample string 1",
    "name": "sample string 2",
    "dateOfBirth": "2025-10-25T11:05:23.8882701+01:00",
    "gender": "sample string 4",
    "jurisdiction": "sample string 5",
    "citizenship": "sample string 6",
    "transactionReference": "sample string 7",
    "address": {
      "name": "sample string 1",
      "number": "sample string 2",
      "address1": "sample string 3",
      "address2": "sample string 4",
      "locality": "sample string 5",
      "town": "sample string 6",
      "county": "sample string 7",
      "postcode": "sample string 8",
      "country": "sample string 9"
    },
    "watchlistChecks": [
      {
        "name": "sample string 1",
        "gender": "sample string 2",
        "dob": "2025-10-25T11:05:23.8882701+01:00",
        "alertIdentifier": "sample string 4",
        "checkName": "sample string 5",
        "matchCategory": "sample string 6",
        "matchIdentifier": "sample string 7",
        "percentageMatch": "sample string 8",
        "relatedName": "sample string 9"
      },
      {
        "name": "sample string 1",
        "gender": "sample string 2",
        "dob": "2025-10-25T11:05:23.8882701+01:00",
        "alertIdentifier": "sample string 4",
        "checkName": "sample string 5",
        "matchCategory": "sample string 6",
        "matchIdentifier": "sample string 7",
        "percentageMatch": "sample string 8",
        "relatedName": "sample string 9"
      }
    ],
    "sanctions": true,
    "highRiskPep": true,
    "standardRiskPep": true,
    "highRiskSip": true,
    "standardRiskSip": true,
    "highRiskRca": true,
    "standardRiskRca": true
  },
  "secondaryPerson": {
    "personId": "sample string 1",
    "name": "sample string 2",
    "dateOfBirth": "2025-10-25T11:05:23.8882701+01:00",
    "gender": "sample string 4",
    "jurisdiction": "sample string 5",
    "citizenship": "sample string 6",
    "transactionReference": "sample string 7",
    "address": {
      "name": "sample string 1",
      "number": "sample string 2",
      "address1": "sample string 3",
      "address2": "sample string 4",
      "locality": "sample string 5",
      "town": "sample string 6",
      "county": "sample string 7",
      "postcode": "sample string 8",
      "country": "sample string 9"
    },
    "watchlistChecks": [
      {
        "name": "sample string 1",
        "gender": "sample string 2",
        "dob": "2025-10-25T11:05:23.8882701+01:00",
        "alertIdentifier": "sample string 4",
        "checkName": "sample string 5",
        "matchCategory": "sample string 6",
        "matchIdentifier": "sample string 7",
        "percentageMatch": "sample string 8",
        "relatedName": "sample string 9"
      },
      {
        "name": "sample string 1",
        "gender": "sample string 2",
        "dob": "2025-10-25T11:05:23.8882701+01:00",
        "alertIdentifier": "sample string 4",
        "checkName": "sample string 5",
        "matchCategory": "sample string 6",
        "matchIdentifier": "sample string 7",
        "percentageMatch": "sample string 8",
        "relatedName": "sample string 9"
      }
    ],
    "sanctions": true,
    "highRiskPep": true,
    "standardRiskPep": true,
    "highRiskSip": true,
    "standardRiskSip": true,
    "highRiskRca": true,
    "standardRiskRca": true
  },
  "attributes": [
    {
      "identifier": "sample string 1",
      "description": "sample string 2",
      "personLevel": "sample string 3",
      "value": "sample string 4",
      "numericValue": 5
    },
    {
      "identifier": "sample string 1",
      "description": "sample string 2",
      "personLevel": "sample string 3",
      "value": "sample string 4",
      "numericValue": 5
    }
  ]
}

application/xml, text/xml

Sample:

<AMLResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EquifaxConnector.AML">
  <proposalNumber>sample string 2</proposalNumber>
  <requestReference>sample string 1</requestReference>
</AMLResponse>