Developer Centre
Platform LoginStatus
  • Getting started
    • Integration types
    • Generating an authentication token
    • Using basic authentication
  • Applicants
    • Creating an applicant
    • Generating a verification link
    • Uploading documents to an applicant
      • Supported Documents and Types
    • Requesting to start the verification process
  • Applicant Results
    • Retrieving applicant verification results
      • Understanding applicant rejection labels
      • Setting up a webhook
    • Downloading verified documents
  • Entities
    • Check types and coverage
    • Creating an entity
    • Generating a verification link
    • Uploading documents to an entity
      • Supported Documents and Types
    • Linking a UBO to an entity
    • Requesting to start the verification process
  • Entity Results
    • Retrieving entity verification results
      • Understanding entity rejection labels
      • Setting up a webhook
    • Retrieving entity ownership structures
    • Retrieving entity questionnaire answers
  • Anti-Money Laundering
    • Retrieving AML results
  • Database Verification
    • Applicants
      • Verifying applicant identity data
    • Entities
      • Verifying entity information
  • Pages
    • Overview
    • Creating a Page
    • Verifying with Pages
  • Domain Names
    • Overview
    • Linking your domain
  • Flow Logic
    • Overview
  • Workspaces
    • Switching Workspaces
  • Modules
Powered by GitBook
On this page

Was this helpful?

  1. Entity Results

Retrieving entity ownership structures

Once a verification has processed, you can retrieve the entity's ownership structure.

Retrieving the ownership structure of an entity is simple, and is available for manually-entered or automatically-detected directors, shareholders, universal beneficial owners, or others.

Retrieving an entity's ownership structure

POST /api-retrieve-ubo

Once the entity has been verified, retrieve the ownership structure and information.

Headers

Name
Value

Content-Type

multipart/form-data

Authorization

Bearer YOUR_TOKEN

Body

Name
Type
Description

applicantId

string

Unique applicantId generated on entity creation (required)

Response

{
    "ownershipInsight": {
        "parentEntity": "1725329761404x0000000000000",
        "applicantId": "1725367823259x00000000000000",
        "uboType": "Individual",
        "name": "SIMONE LEE HARDING",
        "detectedPosition": [
            "Secretary",
            "UBO",
            "Shareholder",
            "Director"
        ],
        "inputtedPosition": "null",
        "address": "123 EXAMPLE LANE, PERTH, 6000, WA, AU",
        "registrationNumber": "null",
        "shares": [
            "5000000"
        ],
        "shareClass": [
            "ORD"
        ]
    },
    "ownershipInsight": {
        "parentEntity": "1725329761404x0000000000000",
        "applicantId": "null",
        "uboType": "Entity",
        "name": "EXAMPLE CO PTY LTD",
        "detectedPosition": [
            "Shareholder"
        ],
        "inputtedPosition": "null",
        "address": "321 EXAMPLE STREET, PERTH, 6000, WA AU",
        "registrationNumber": "123000456",
        "shares": [
            "100000"
        ],
        "shareClass": [
            "ORD"
        ]
    }
{
    "statusCode": 400,
    "message": "Error: incorrect applicantId provided"
}

detectedPosition types are roles that we've automatically identified during verification.

inputtedPosition types are roles that the entity has manually entered, in the event of manual fallback.

Note: The applicantId can be empty/null when the representative has been identified, but not yet verified. If applicable, once an applicant or entity has been created to verify the representative, manually or automatically in a flow, the applicantId will appear.

PreviousSetting up a webhookNextRetrieving entity questionnaire answers

Last updated 8 months ago

Was this helpful?