AML - Retrieve Profile

Requirements

• API key pair
• Previous check that returned profiles

---

AML check flow - Retrieve profile

Have question?

You can find more explanation in Help center

---

Limitation

Information inside profiles are not filtered by check filters, so profile information will contain all conditions and informaiton.

Retrieve AML check profile

https://ivs.idenfy.com/aml/checks/{id}/profiles/{profileId}/

Authorizations:

API key pair

path Parameters

id required	string <uuid> A UUID string identifying this AML check.
profileId required	string resourceId from AML database search result.

Responses

Response samples

• 200

Content type

application/json

Example

IndividualProfileSchemaBusinessProfileSchemaIndividualProfileSchema

{

• "version": 0,
• "resourceId": "string",
• "firstName": "string",
• "middleName": "string",
• "lastName": "string",
• "gender": "MALE",
• "isDeleted": false,
• "deletionReason": {

  • "reason": "GOVERNMENT_POSITION_OUT_OF_SCOPE",
  • "otherReason": "string"

  },
• "isDeceased": false,
• "aliases": [

  • {

    • "firstName": "string",
    • "middleName": "string",
    • "lastName": "string",
    • "type": "ORIGINAL_SCRIPT_NAME"

    }

  ],
• "datesOfBirth": [

  • "string"

  ],
• "datesOfDeath": [

  • "string"

  ],
• "nationalities": [

  • "AF"

  ],
• "addresses": [

  • {

    • "line1": "string",
    • "line2": "string",
    • "postcode": "string",
    • "city": "string",
    • "county": "string",
    • "countyAbbrev": "string",
    • "country": "AF",
    • "addressType": "PLACE_OF_BIRTH"

    }

  ],
• "profileImages": [

  • "string"

  ],
• "notes": [

  • {

    • "value": "string"

    }

  ],
• "contactEntries": [

  • {

    • "category": "TELEPHONE",
    • "value": "string"

    }

  ],
• "identifiers": [

  • {

    • "category": "string",
    • "value": "string"

    }

  ],
• "evidences": [

  • {

    • "evidenceId": "string",
    • "originalUrl": "string",
    • "isCopyrighted": false,
    • "title": "string",
    • "credibility": "LOW",
    • "language": "string",
    • "summary": "string",
    • "keywords": "string",
    • "captureDate": "string",
    • "publicationDate": "string",
    • "assetUrl": "string",
    • "datasets": [

      • "PEP_CURRENT"

      ]

    }

  ],
• "sanEntries": {

  • "current": [

    • {

      • "sanctionId": "string",
      • "measures": [

        • "string"

        ],
      • "regime": {

        • "body": "string",
        • "bodyId": 0,
        • "name": "string",
        • "origin": "string",
        • "types": [

          • "COUNTER_NARCOTICS"

          ]

        },
      • "events": [

        • {

          • "type": "ADDED",
          • "date": "string",
          • "evidenceIds": [

            • "string"

            ]

          }

        ]

      }

    ],
  • "former": [

    • {

      • "sanctionId": "string",
      • "measures": [

        • "string"

        ],
      • "regime": {

        • "body": "string",
        • "bodyId": 0,
        • "name": "string",
        • "origin": "string",
        • "types": [

          • "COUNTER_NARCOTICS"

          ]

        },
      • "events": [

        • {

          • "type": "ADDED",
          • "date": "string",
          • "evidenceIds": [

            • "string"

            ]

          }

        ]

      }

    ]

  },
• "relEntries": [

  • {

    • "category": "FINANCIAL_REGULATOR",
    • "subcategory": "string",
    • "events": [

      • {

        • "type": "string",
        • "currencyCode": "string",
        • "amount": 0,
        • "period": {

          • "days": 0,
          • "years": 0,
          • "months": 0

          },
        • "date": "string",
        • "evidenceIds": [

          • "string"

          ]

        }

      ]

    }

  ],
• "rreEntries": [

  • {

    • "category": "string",
    • "subcategory": "string",
    • "events": [

      • {

        • "type": "string",
        • "date": "string",
        • "evidenceIds": [

          • "string"

          ]

        }

      ]

    }

  ],
• "poiEntries": [

  • {

    • "category": "string",
    • "evidenceIds": [

      • "string"

      ],
    • "positions": [

      • {

        • "position": "string",
        • "segment": "string",
        • "country": "AF",
        • "dateFrom": "string",
        • "dateTo": "string"

        }

      ]

    }

  ],
• "insEntries": [

  • {

    • "type": "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",
    • "evidenceIds": [

      • "string"

      ]

    }

  ],
• "ddEntries": [

  • {

    • "caseReference": "string",
    • "reason": "string",
    • "conduct": "string",
    • "dateFrom": "string",
    • "dateTo": "string",
    • "evidenceIds": [

      • "string"

      ]

    }

  ],
• "pepEntries": {

  • "pepTier": "PEP_TIER_1",
  • "current": [

    • {

      • "country": "AF",
      • "segment": "string",
      • "position": "string",
      • "dateFrom": "string",
      • "dateTo": "string",
      • "evidenceIds": [

        • "string"

        ]

      }

    ],
  • "former": [

    • {

      • "country": "AF",
      • "segment": "string",
      • "position": "string",
      • "dateFrom": "string",
      • "dateTo": "string",
      • "evidenceIds": [

        • "string"

        ]

      }

    ]

  },
• "pepByAssociationEntries": [

  • {

    • "resourceId": "string",
    • "evidenceIds": [

      • "string"

      ]

    }

  ],
• "individualLinks": [

  • {

    • "resourceId": "string",
    • "relationship": "string",
    • "ownershipPercentage": 0,
    • "firstName": "string",
    • "middleName": "string",
    • "lastName": "string",
    • "datasets": [

      • "PEP_CURRENT"

      ]

    }

  ],
• "businessLinks": [

  • {

    • "resourceId": "string",
    • "relationship": "string",
    • "ownershipPercentage": 0,
    • "name": "string",
    • "datasets": [

      • "PEP_LINKED"

      ],
    • "individualLinks": [

      • {

        • "resourceId": "string",
        • "relationship": "string",
        • "ownershipPercentage": 0,
        • "firstName": "string",
        • "middleName": "string",
        • "lastName": "string",
        • "datasets": [

          • "PEP_CURRENT"

          ]

        }

      ]

    }

  ],
• "griEntries": [

  • {

    • "evidenceId": "string",
    • "title": "string",
    • "summary": "string",
    • "keywords": "string"

    }

  ],
• "datasets": [

  • "PEP_CURRENT"

  ]

}

Authentication

API Key *

API Secret *

Path Parameters

Check ID (id) *

The UUID of the AML check.

Profile ID (profileId) *

The resourceId from the AML search result.

Request

{
  "Request URL (GET)": ""
}

Response

---

Generate AML check profile PDF

https://ivs.idenfy.com/aml/checks/{id}/profiles/{profileId}/pdf/

Authorizations:

API key pair

path Parameters

id required	string <uuid> A UUID string identifying this AML check.
profileId required	string resourceId from AML database search result.

Request Body schema: application/json

password

string non-empty

Responses

Request samples

• Payload

Content type

application/json

{

• "password": "string"

}