POST
/
searchEntityScreening
curl --request POST \
  --url https://gateway.finhub.cloud/peps/searchEntityScreening \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-token: <x-token>' \
  --data '{
  "data": [
    {
      "id": "3431145",
      "type": "RiskEntities",
      "attributes": {
        "type": "Person",
        "primary_name": "Smith, John",
        "title": "",
        "country_territory_code": "INDON",
        "country_territory_name": "Indonesia",
        "gender": "Male",
        "is_subsidiary": false,
        "score": "1.0",
        "icon_hints": [
          "SI-LT"
        ],
        "countries_territories": [
          {
            "type": "Citizenship",
            "code": "INDON"
          },
          {
            "type": "Resident of",
            "code": "INDON"
          },
          {
            "type": "Country of Reported Allegation",
            "code": "INDON"
          }
        ],
        "date_of_birth": [
          {
            "day": "",
            "month": "",
            "year": "1992"
          },
          {
            "day": "",
            "month": "",
            "year": "1993"
          }
        ],
        "matched_criteria": {
          "date_of_birth": {},
          "name": {
            "name": "John Smith"
          },
          "type": {
            "type": "Precise",
            "is_linguistic_variation": false,
            "is_non_linguistic_variation": false,
            "is_structural_variation": false
          }
        }
      }
    },
    {
      "id": "369665",
      "type": "RiskEntities",
      "attributes": {
        "type": "Person",
        "primary_name": "Smith, John Jane",
        "title": "See Previous Roles",
        "country_territory_code": "USA",
        "country_territory_name": "United States",
        "gender": "Male",
        "is_subsidiary": false,
        "score": "1.0",
        "icon_hints": [
          "PEP"
        ],
        "countries_territories": [
          {
            "type": "Citizenship",
            "code": "USA"
          },
          {
            "type": "Resident of",
            "code": "USA"
          },
          {
            "type": "Jurisdiction",
            "code": "USA"
          },
          {
            "type": "Jurisdiction",
            "code": "INTERNATIONAL"
          }
        ],
        "date_of_birth": [
          {
            "day": "19",
            "month": "8",
            "year": "1946"
          }
        ],
        "matched_criteria": {
          "date_of_birth": {},
          "name": {
            "name": "John Jane Smith"
          },
          "type": {
            "type": "Precise",
            "is_linguistic_variation": false,
            "is_non_linguistic_variation": false,
            "is_structural_variation": false
          }
        }
      }
    }
  ]
}'

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-token
string
required

authentication token from getAcessToken response

Body

application/json ยท object

The body is of type object.