Skip to main content

Generate Entity Profile Report (EPR)

GET 
/report/entityprofile/base/:output_type/:method

EPR API generates a data response containing the subject individual or company’s basic profile, current and past appointments, current and past shareholding/shareholders, charges, and associated entities.

Available for: all Handshakes datasets.

Report format: JSON, PDF, XML

Request​

Path Parameters

    method stringrequired

    Possible values: [1, 2, 3]

    Method to retrieve the entity report.
    1 - Request by UEN and source short name
    2 - Request by entity GUID and source GUID
    3 - Request by entity GUID and source short name

    output_type stringrequired

    Possible values: [pdf, xml, json]

    File type of the report output.
    pdf - Portable Document Format (PDF)
    xml - Extensible Markup Language (XML)
    json - Javascript Object Notation (JSON)

Query Parameters

    entityGuid string

    The entity GUID of the subject company.

    (e.g. E000D000-11F1-22D2-3333-4444444AC4E4)
    This is required for method 2, 3.
    For available values to input, refer to output of SEARCH: Basic Entity Search endpoint.

    sourceGuid string

    Dataset source GUID.

    For queries against any of Handshakes single datasets, enter only 1 source in this field.
    (e.g. 4af00c3f-bda4-490c-8c7b-c7645b)
    For queries against Handshakes OneWorld, enter more than 1 sources in this field.
    (e.g. 4af00c3f-bda4-490c-8c7b-c7645b, 73e4c5c3-58c7-4f4e-837c-41411a19abca)
    This is required for method 2. For available values to input, refer to output of SEARCH: Data Source Search endpoint.

    uen string

    The target entity’s company registration number (e.g. 201108160R).

    This is required for method 1.
    For available values to input, refer to output of SEARCH: Basic Entity Search endpoint.

    sourceshortname string

    Dataset source short name (e.g. CRSG).

    For queries against any of Handshakes single datasets, enter only 1 source in this field.
    (e.g. CRSG)
    For queries against Handshakes OneWorld, enter more than 1 sources in this field.
    (e.g. CRMY, CRSG, CM)
    This is required for method 1, 3.
    For available values to input, refer to output of SEARCH: Data Source Search endpoint.

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.

Responses​

Schema
    EntityType string
    ReportDateTime string
    EntityGuid string
    DirectRedScore string
    IndirectRedScore string
    NetworkScore object
    DegreeCentrality string
    ActiveName string
    CurrentNameEffDate string
    Profile object
    Dataset string
    FormerNames object
    Name string
    EffectiveDate string
    IdType string
    CompanyRegistrationNo string
    CurrentAddress string
    Type string
    PlaceOfIncorporation string
    IncorporationDate string
    CompanyStatus string
    PrimaryBusinessCode string
    PrimaryBusinessActivity string
    SecondaryBusinessCode string
    SecondaryBusinessActivity string
    OwnershipLayers string
    PersonProbableAssociates object
    PersonName string
    PersonConnectionCount integer
    CompanyProbableAssociates object
    CompanyName string
    CompanyConnectionCount integer
    ShareCapitals object
    ShareCategory string
    ShareType string
    Amount float
    NumberOfShares string
    Currency string
    CurrentAppointmentHolders object
    Name string
    Address string
    IdentificationNo string
    IdType string
    Nationality string
    Appointment string
    AppointmentDate string
    PastAppointmentHolders object
    FromDate string
    ToDate string
    Name string
    Address string
    IdentificationNo string
    IdType string
    Nationality string
    Appointment string
    AppointmentDate string
    ShareHolders object
    Name string
    EntityType string
    IdentificationNumber string
    IdType string
    IncorporationNationality string
    Address string
    ShareType string
    NumberOfShares string
    LatestDisclosureDate string
    Currency string
    PastShareholders object
    Name string
    EntityType string
    IdentificationNumber string
    IdType string
    IncorporationNationality string
    Address string
    ShareType string
    LatestDisclosureDate string
    RecentMentions array
    Family array
    CurrentCharges object
    Dataset string
    ChargeNo string
    DateRegistered string
    Chargees object
    Name string
    IdentificationNumber string
    AmountSecured object
    Amount string
    NatureOfSatisfaction string
    Status string
    PastCharges object
    Dataset string
    ChargeNo string
    DateRegistered string
    Chargees object
    Name string
    IdentificationNumber string
    AmountSecured object
    Amount string
    NatureOfSatisfaction string
    Status string