Skip to main content

Generate Regulatory, Enforcement and Disciplinary actions Report (RED)

POST 

/report/redlist

RED Report API generates a data response containing the subject individual or company’s direct & indirect exposure to regulatory actions by national, regional and international authorities.

Available for: all Handshakes datasets, except for Vietnam Company Registry (CRVN).

Report format: JSON, XML, PDF, HTML

Request

Header Parameters

    Authorization stringrequired

    Refer to Getting your Access Token to get access to the authorization token. Include the following prefix when using the authorization token: Bearer.

Body

required
    entity_guid string

    The entity GUID of the subject company (e.g. E000D000-11F1-22D2-3333-4444444AC4E4).
    For available values to input, refer to output of SEARCH: Basic Entity Search endpoint.
    Either entity_guid or uen is required.

    uen string

    The target entity’s company registration number (e.g. 201108160R).
    For available values to input, refer to output of SEARCH: Basic Entity Search endpoint.
    Either entity_guid or uen is required.

    source string

    Dataset source GUID (e.g. 4af00c3f-bda4-490c-8c7b-c7645b).
    For available values to input, refer to output of SEARCH: Data Source Search endpoint.
    Either source or sourceshortname is required.

    sourceshortname string

    Dataset source short name (e.g. CRSG)
    For available values to input, refer to output of SEARCH: Data Source Search endpoint.
    Either source or sourceshortname is required.

    datasets string[]

    Array of dataset GUIDs. This field is required for OneWorld to function properly.
    For available values to input, refer to output of SEARCH: Data Source Search endpoint.
    Either datasets or datasetsshortname is required.

    datasetsshortname string[]

    Array of dataset names. This field is required for OneWorld to function properly.
    For available values to input, refer to output of SEARCH: Data Source Search endpoint.
    Either datasets or datasetsshortname is required.

    output_type string

    File type of the report output.

    Possible values: [json, html, pdf, xml]

    Default value: pdf

Responses

Schema
    EntityType string
    ReportDateTime string
    EntityGuid string
    IndirectRedScore string
    ActiveName string
    Profiles object
    FormerNames object
    Name string
    EffectiveDate string
    CompanyRegistrationNo string
    CurrentAddress string
    OtherAddress string[]
    Type string
    PlaceOfIncorporation string
    IncorporationDate string
    CompanyStatus string
    PrimaryBusinessActivity string
    OwnershipLayer string
    DirectExposures object
    EventName string
    EventDetails string
    InvolvedEntities object
    EntityName string
    Involvement string
    Details string
    IndirectExposureRelationships object
    EntityFromName string
    RelationshipType string
    EntityToName string
    RelationshipStartDate string
    PastRelationship string
    IndirectExposureEvents object
    EventType string
    TargetEntity string
    EventName string
    EventDetails string