Skip to main content
GET
/
aml
/
checks
/
{id}
/
profiles
/
{profileId}
Retrieve AML check profile
curl --request GET \
  --url https://api.example.com/aml/checks/{id}/profiles/{profileId}/ \
  --header 'Authorization: Basic <encoded-value>'
{
  "version": 123,
  "resourceId": "<string>",
  "lastName": "<string>",
  "aliases": [
    {
      "type": "ORIGINAL_SCRIPT_NAME",
      "firstName": "<string>",
      "middleName": "<string>",
      "lastName": "<string>"
    }
  ],
  "datesOfBirth": [
    "<string>"
  ],
  "datesOfDeath": [
    "<string>"
  ],
  "nationalities": [
    "AF"
  ],
  "addresses": [
    {
      "country": "AF",
      "addressType": "PLACE_OF_BIRTH",
      "line1": "<string>",
      "line2": "<string>",
      "postcode": "<string>",
      "city": "<string>",
      "county": "<string>",
      "countyAbbrev": "<string>"
    }
  ],
  "profileImages": [
    "<string>"
  ],
  "notes": [
    {
      "value": "<string>"
    }
  ],
  "contactEntries": [
    {
      "category": "TELEPHONE",
      "value": "<string>"
    }
  ],
  "identifiers": [
    {
      "category": "<string>",
      "value": "<string>"
    }
  ],
  "evidences": [
    {
      "evidenceId": "<string>",
      "originalUrl": "<string>",
      "datasets": [
        "PEP_CURRENT"
      ],
      "isCopyrighted": false,
      "title": "<string>",
      "credibility": "LOW",
      "language": "<string>",
      "summary": "<string>",
      "keywords": "<string>",
      "captureDate": "<string>",
      "publicationDate": "<string>",
      "assetUrl": "<string>"
    }
  ],
  "sanEntries": {
    "current": [
      {
        "measures": [
          "<string>"
        ],
        "regime": {
          "body": "<string>",
          "origin": "<string>",
          "bodyId": 123,
          "name": "<string>",
          "types": [
            "COUNTER_NARCOTICS"
          ]
        },
        "events": [
          {
            "type": "ADDED",
            "date": "<string>",
            "evidenceIds": [
              "<string>"
            ]
          }
        ],
        "sanctionId": "<string>"
      }
    ],
    "former": [
      {
        "measures": [
          "<string>"
        ],
        "regime": {
          "body": "<string>",
          "origin": "<string>",
          "bodyId": 123,
          "name": "<string>",
          "types": [
            "COUNTER_NARCOTICS"
          ]
        },
        "events": [
          {
            "type": "ADDED",
            "date": "<string>",
            "evidenceIds": [
              "<string>"
            ]
          }
        ],
        "sanctionId": "<string>"
      }
    ]
  },
  "relEntries": [
    {
      "category": "FINANCIAL_REGULATOR",
      "subcategory": "<string>",
      "events": [
        {
          "type": "<string>",
          "evidenceIds": [
            "<string>"
          ],
          "currencyCode": "<string>",
          "amount": 123,
          "period": {
            "days": 123,
            "years": 123,
            "months": 123
          },
          "date": "<string>"
        }
      ]
    }
  ],
  "rreEntries": [
    {
      "category": "<string>",
      "events": [
        {
          "type": "<string>",
          "evidenceIds": [
            "<string>"
          ],
          "date": "<string>"
        }
      ],
      "subcategory": "<string>"
    }
  ],
  "poiEntries": [
    {
      "category": "<string>",
      "evidenceIds": [
        "<string>"
      ],
      "positions": [
        {
          "position": "<string>",
          "segment": "<string>",
          "country": "AF",
          "dateFrom": "<string>",
          "dateTo": "<string>"
        }
      ]
    }
  ],
  "insEntries": [
    {
      "type": "<string>",
      "evidenceIds": [
        "<string>"
      ],
      "insolvencyIdNumber": "<string>",
      "solicitor": "<string>",
      "court": "<string>",
      "petitioner": "<string>",
      "debt": "<string>",
      "accountantInBankruptcyCaseNumber": "<string>",
      "insolvencyStartDate": "<string>",
      "insolvencyEndDate": "<string>",
      "hearingDate": "<string>",
      "presentedDateOfPetition": "<string>",
      "gazetteIssueDate": "<string>",
      "awardDate": "<string>",
      "firstOrderDate": "<string>"
    }
  ],
  "ddEntries": [
    {
      "reason": "<string>",
      "evidenceIds": [
        "<string>"
      ],
      "caseReference": "<string>",
      "conduct": "<string>",
      "dateFrom": "<string>",
      "dateTo": "<string>"
    }
  ],
  "pepEntries": {
    "current": [
      {
        "position": "<string>",
        "evidenceIds": [
          "<string>"
        ],
        "country": "AF",
        "segment": "<string>",
        "dateFrom": "<string>",
        "dateTo": "<string>"
      }
    ],
    "former": [
      {
        "position": "<string>",
        "evidenceIds": [
          "<string>"
        ],
        "country": "AF",
        "segment": "<string>",
        "dateFrom": "<string>",
        "dateTo": "<string>"
      }
    ],
    "pepTier": "PEP_TIER_1"
  },
  "pepByAssociationEntries": [
    {
      "resourceId": "<string>",
      "evidenceIds": [
        "<string>"
      ]
    }
  ],
  "individualLinks": [
    {
      "resourceId": "<string>",
      "relationship": "<string>",
      "lastName": "<string>",
      "datasets": [
        "PEP_CURRENT"
      ],
      "ownershipPercentage": 123,
      "firstName": "<string>",
      "middleName": "<string>"
    }
  ],
  "businessLinks": [
    {
      "resourceId": "<string>",
      "relationship": "<string>",
      "name": "<string>",
      "datasets": [
        "PEP_LINKED"
      ],
      "ownershipPercentage": 123,
      "individualLinks": [
        {
          "resourceId": "<string>",
          "relationship": "<string>",
          "lastName": "<string>",
          "datasets": [
            "PEP_CURRENT"
          ],
          "ownershipPercentage": 123,
          "firstName": "<string>",
          "middleName": "<string>"
        }
      ]
    }
  ],
  "griEntries": [
    {
      "evidenceId": "<string>",
      "title": "<string>",
      "summary": "<string>",
      "keywords": "<string>"
    }
  ],
  "datasets": [
    "PEP_CURRENT"
  ],
  "firstName": "<string>",
  "middleName": "<string>",
  "gender": "MALE",
  "isDeleted": false,
  "isDeceased": false
}

Authorizations

​
Authorization
string
header
required

The request must contain basic auth headers where username is API key and password is API secret.
In order for you to start using our API you will need an API key and API secret.
Both can be retrieved by contacting iDenfy's support or iDenfy's sales team.

Path Parameters

​
id
string<uuid>
required

A UUID string identifying this AML check.

​
profileId
string
required

resourceId from AML database search result.

Response

200 - application/json
​
version
integer
required

The version number can be used by clients to detect when a profile has been changed by our research team.

​
resourceId
string
required

The resource ID can be used to retrieve the full profile or the PDF of the individual.

​
lastName
string
required

The last name of the individual.

​
aliases
object[]
required

Defines a list of aliases for the individual.

​
datesOfBirth
string[]
required

The list of birth dates for the individual.

​
datesOfDeath
string[]
required

The list of death dates for the individual.

​
nationalities
enum<string>[]
required

List of the individual's nationalities.

Available options:
AF,
AX,
AL,
DZ,
AS,
AD,
AO,
AI,
AQ,
AG,
AR,
AM,
AW,
AU,
AT,
AZ,
BS,
BH,
BD,
BB,
BY,
BE,
BZ,
BJ,
BM,
BT,
BO,
BQ,
BA,
BW,
BV,
BR,
IO,
BN,
BG,
BF,
BI,
CV,
KH,
CM,
CA,
KY,
CF,
TD,
CL,
CN,
CX,
CC,
CO,
KM,
CG,
CK,
CR,
CI,
HR,
CU,
CW,
CY,
CZ,
CD,
DK,
DJ,
DM,
DO,
EC,
EG,
SV,
GQ,
ER,
EE,
SZ,
ET,
FK,
FO,
FJ,
FI,
FR,
GF,
PF,
TF,
GA,
GM,
GE,
DE,
GH,
GI,
GR,
GL,
GD,
GP,
GU,
GT,
GG,
GN,
GW,
GY,
HT,
HM,
HN,
HK,
HU,
IS,
IN,
ID,
IR,
IQ,
IE,
IM,
IL,
IT,
JM,
JP,
JE,
JO,
KZ,
KE,
KI,
XK,
KW,
KG,
LA,
LV,
LB,
LS,
LR,
LY,
LI,
LT,
LU,
MO,
MG,
MW,
MY,
MV,
ML,
MT,
MH,
MQ,
MR,
MU,
YT,
MX,
FM,
MD,
MC,
MN,
ME,
MS,
MA,
MZ,
MM,
NA,
NR,
NP,
NL,
NC,
NZ,
NI,
NE,
NG,
NU,
NF,
KP,
MK,
MP,
NO,
OM,
PK,
PW,
PS,
PA,
PG,
PY,
PE,
PH,
PN,
PL,
PT,
PR,
QA,
RE,
RO,
RU,
RW,
BL,
SH,
KN,
LC,
MF,
PM,
VC,
WS,
SM,
ST,
SA,
SN,
RS,
SC,
SL,
SG,
SX,
SK,
SI,
SB,
SO,
ZA,
GS,
KR,
SS,
ES,
LK,
SD,
SR,
SJ,
SE,
CH,
SY,
TW,
TJ,
TZ,
TH,
TL,
TG,
TK,
TO,
TT,
TN,
TR,
TM,
TC,
TV,
UG,
UA,
AE,
GB,
UM,
US,
UY,
UZ,
VU,
VA,
VE,
VN,
VG,
VI,
WF,
EH,
YE,
ZM,
ZW
​
addresses
object[]
required

The list of the individual's addresses.

​
profileImages
string[]
required

Contains a list of URLs to profiles images for the individual.

​
notes
object[]
required
​
contactEntries
object[]
required
​
identifiers
object[]
required
​
evidences
object[]
required
​
sanEntries
object
required

Serializer for current and former sanction entries.

​
relEntries
object[]
required
​
rreEntries
object[]
required
​
poiEntries
object[]
required
​
insEntries
object[]
required
​
ddEntries
object[]
required
​
pepEntries
object
required

Serializer for current and former PEP entries.

​
pepByAssociationEntries
object[]
required
​
individualLinks
object[]
required
​
businessLinks
object[]
required
​
griEntries
object[]
required
​
datasets
enum<string>[]
required

The profile datasets

  • PEP_CURRENT - Only current PEPs
  • PEP_FORMER - Only former PEPs
  • PEP_LINKED - Only linked PEPs (PEP by Association)
  • SAN_CURRENT - Only current Sanctions
  • SAN_FORMER - Only former Sanctions
  • INS - Insolvency
  • RRE - Reputational Risk Exposure
  • DD - Disqualified Director
  • POI - Profile Of Interest
  • REL - Regulatory Enforcement List
  • GRI - Gambling Risk Intelligence.
Available options:
PEP_CURRENT,
PEP_FORMER,
PEP_LINKED,
SAN_CURRENT,
SAN_FORMER,
INS,
RRE,
DD,
POI,
REL,
GRI
​
firstName
string

The first name of the individual.

​
middleName
string

The middle name of the individual.

​
gender
enum<string>

The gender of the individual.

Available options:
MALE,
FEMALE
​
isDeleted
boolean
default:false

A true value indicates that the individual has been deleted by our research team.

​
deletionReason
object
​
isDeceased
boolean
default:false

A true value indicates that the individual is deceased.