Sign in

v1

latestOpenAPI 3.1.02026-08-042010999.7 KB
Monitoring: Entity Management

Retrieve a profile information, divided by match

This endpoint returns profile information (KYC and Facets), but match-by-match. This allows you to correlate profile information to matches.

post/entity/{entityURN}/profile-by-matches

Path parameters

entityURNstring required

The entity ID or URN.

Example:urn:sigma:entity:1234-abcdef

The entity ID or URN.

Request body

sigmaIDsstring[] nullable

Optional. Narrow the results to only include these Sigma IDs.

Response

OK

aliasesstring[]
economicActivitiesobject nullable
facetTypestring
sigmaIDstring

Example response

{
  "aliasesWithSources": [
    {
      "sourceAttribution": [
        "abcd1234//1234567890"
      ],
      "value": "<text>"
    }
  ],
  "corporateNumbers": [
    {
      "sourceAttribution": [
        "abcd1234//1234567890"
      ]
    }
  ],
  "dobs": [
    {
      "humanReadable": "Circa 1980",
      "sourceAttribution": [
        "abcd1234//1234567890"
      ],
      "until": "2023-01-01T00:00:00Z",
      "value": "2023-01-01T00:00:00Z"
    }
  ],
  "facts": [
    {
      "label": "Notes",
      "sourceAttribution": [
        "abcd1234//1234567890"
      ],
      "value": "<text>"
    }
  ],
  "foundedDates": [
    {
      "humanReadable": "Circa 1980",
      "sourceAttribution": [
        "abcd1234//1234567890"
      ],
      "until": "2023-01-01T00:00:00Z",
      "value": "2023-01-01T00:00:00Z"
    }
  ],
  "genders": [
    {
      "sourceAttribution": [
        "abcd1234//1234567890"
      ],
      "value": "<text>"
    }
  ],
  "identifications": [
    {
      "sourceAttribution": [
        "abcd1234//1234567890"
      ]
    }
  ],
  "imo": {
    "sourceAttribution": [
      "abcd1234//1234567890"
    ],
    "value": "<text>"
  },
  "incorporationTypes": [
    {
      "sourceAttribution": [
        "abcd1234//1234567890"
      ],
      "value": "<text>"
    }
  ],
  "linesOfBusiness": [
    {
      "sourceAttribution": [
        "abcd1234//1234567890"
      ],
      "value": "<text>"
    }
  ],
  "locations": [
    {
      "address": "10 Downing St, London SW1A 2AB, United Kingdom",
      "country": "United Kingdom",
      "countryCode": "GB",
      "fromDate": "1684-05-20",
      "locality": "London",
      "majorAdministrativeDivision": "England",
      "minorAdministrativeDivision": "City of Westminster",
      "postalCode": "SW1A 2AB",
      "sourceAttribution": [
        "abcd1234//1234567890"
      ],
      "streetName": "Downing St",
      "streetNumber": "10",
      "toDate": "2020-05-20",
      "type": "Residence"
    }
  ],
  "manufactureDates": [
    {
      "humanReadable": "Circa 1980",
      "sourceAttribution": [
        "abcd1234//1234567890"
      ],
      "until": "2023-01-01T00:00:00Z",
      "value": "2023-01-01T00:00:00Z"
    }
  ],
  "maritimeCallSigns": [
    {
      "sourceAttribution": [
        "abcd1234//1234567890"
      ],
      "value": "<text>"
    }
  ],
  "models": [
    {
      "sourceAttribution": [
        "abcd1234//1234567890"
      ],
      "value": "<text>"
    }
  ],
  "nationalities": [
    {
      "sourceAttribution": [
        "abcd1234//1234567890"
      ],
      "value": "<text>"
    }
  ],
  "operators": [
    {
      "sourceAttribution": [
        "abcd1234//1234567890"
      ],
      "value": "<text>"
    }
  ],
  "otherIdentifiers": [
    {
      "sourceAttribution": [
        "abcd1234//1234567890"
      ]
    }
  ],
  "politicalPositions": [
    {
      "sourceAttribution": [
        "abcd1234//1234567890"
      ]
    }
  ],
  "portsOfRegistry": [
    {
      "sourceAttribution": [
        "abcd1234//1234567890"
      ],
      "value": "<text>"
    }
  ],
  "serialNumbers": [
    {
      "sourceAttribution": [
        "abcd1234//1234567890"
      ],
      "value": "<text>"
    }
  ],
  "statuses": [
    {
      "sourceAttribution": [
        "abcd1234//1234567890"
      ],
      "value": "<text>"
    }
  ],
  "tailNumbers": [
    {
      "sourceAttribution": [
        "abcd1234//1234567890"
      ],
      "value": "<text>"
    }
  ],
  "types": [
    {
      "sourceAttribution": [
        "abcd1234//1234567890"
      ],
      "value": "<text>"
    }
  ]
}