List stakeholders

You can retrieve all stakeholders associated with a verification using the GET endpoint. This is useful for displaying stakeholder status to users, tracking verification progress, or for auditing purposes.


GET/v5/verifications/:trace/stakeholders

List all stakeholders

This endpoint returns summary data for all stakeholders associated with a verification. Each stakeholder summary includes their roles, entity type, name, and timestamps.

Path parameters

  • Name
    trace
    Type
    string
    Description

    The unique identifier for the verification (received when creating the verification).

Response fields

The response contains a data.stakeholders array. Each stakeholder summary includes:

FieldTypeDescription
stakeholderIdstringUnique stakeholder identifier.
rolesstring[]Every role the stakeholder was requested under (e.g., ["director", "shareholder"]).
typestringEntity type (individual, company, trust, etc.).
subTypestringEntity sub-type (e.g., discretionaryTrust, none).
countrystringISO3 country code.
namestringDisplay name (full name for individuals, entity name for companies).
verificationStatusstringCurrent verification state for the stakeholder (e.g., pending, verified, rejected, removed). Optional — absent until the stakeholder has been acted on.
submissionStatusstringData-collection state; "locked" once a retryable stakeholder has exhausted its attempt cap. Optional.
attemptnumberWhich verification attempt the current status belongs to, starting at 1. Present for retryable individual stakeholders — subType: data (resubmitted via the API) and subType: biometric (re-attempted on the hosted eKYC link). Optional.
maxAttemptsnumberThe attempt cap in force (5), so clients can render "attempt x of y" and derive the locked gate from the data. Present alongside attempt. Optional.
rejectionReasonsobject[]Reasons for the latest rejected attempt (reason, description, help). Present on a rejected retryable stakeholder. Optional.
createdAtnumberUnix timestamp of creation.
updatedAtnumberUnix timestamp of last update.
createdTimestringHuman-readable creation time.
updatedTimestringHuman-readable update time.

Request

GET
/v5/verifications/:trace/stakeholders
curl https://dev.bronid.com/v5/verifications/abc123-verification-trace/stakeholders \
  --user "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2:api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314"

Response

{
  "timestamp": "2026-01-30T04:00:00.000Z",
  "serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
  "trace": "abc123-verification-trace",
  "path": "/v5/verifications/:trace/stakeholders",
  "pathParams": {
    "trace": "abc123-verification-trace"
  },
  "statusCode": 200,
  "message": "Stakeholders listed successfully.",
  "help": null,
  "status": "success",
  "data": {
    "stakeholders": [
      {
        "stakeholderId": "stk-id-123",
        "roles": ["trustee"],
        "type": "company",
        "subType": "none",
        "country": "AUS",
        "name": "Smith Trustee Pty Ltd",
        "createdAt": 1737254548899,
        "updatedAt": 1737254548899,
        "createdTime": "30/01/2026 14:00:00",
        "updatedTime": "30/01/2026 14:00:00"
      },
      {
        "stakeholderId": "stk-id-456",
        "roles": ["director"],
        "type": "individual",
        "subType": "none",
        "country": "AUS",
        "name": "John Smith",
        "createdAt": 1737254600000,
        "updatedAt": 1737254600000,
        "createdTime": "30/01/2026 14:05:00",
        "updatedTime": "30/01/2026 14:05:00"
      }
    ]
  },
  "error": null
}

GET/v5/verifications/:trace/stakeholders/:stakeholderId

Get a specific stakeholder

To retrieve full details about a specific stakeholder, use the stakeholder ID in the path. This returns the complete stakeholder data including all entity details, identifiers, and addresses.

Path parameters

  • Name
    trace
    Type
    string
    Description

    The unique identifier for the verification.

  • Name
    stakeholderId
    Type
    string
    Description

    The unique identifier for the stakeholder (from the list response).

Response fields

The response contains the full stakeholder data at data:

FieldTypeDescription
stakeholderIdstringUnique stakeholder identifier.
rolesstring[]Every role the stakeholder was requested under (e.g., ["director", "shareholder"]).
typestringEntity type (individual, company, etc.).
subTypestringEntity sub-type.
countrystringISO3 country code.
firstNamestringFirst name (for individuals).
lastNamestringLast name (for individuals).
namestringEntity name (for companies/trusts).
emailstringContact email.
identifiersobjectEntity identifiers (ABN, ACN, etc.).
addressesobjectEntity addresses.
submissionIdstringReference to the submission that created this stakeholder.
createdAtnumberUnix timestamp of creation.
updatedAtnumberUnix timestamp of last update.
createdTimestringHuman-readable creation time.
updatedTimestringHuman-readable update time.

Error responses

Status CodeError TypeDescription
404not_foundStakeholder not found for the given verification.

Request

GET
/v5/verifications/:trace/stakeholders/:stakeholderId
curl https://dev.bronid.com/v5/verifications/abc123-verification-trace/stakeholders/stk-id-123 \
  --user "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2:api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314"

Response

{
  "timestamp": "2026-01-30T04:05:00.000Z",
  "serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
  "trace": "abc123-verification-trace",
  "path": "/v5/verifications/:trace/stakeholders/:stakeholderId",
  "pathParams": {
    "trace": "abc123-verification-trace",
    "stakeholderId": "stk-id-123"
  },
  "statusCode": 200,
  "message": "Stakeholder details retrieved successfully.",
  "help": null,
  "status": "success",
  "data": {
    "stakeholderId": "stk-id-123",
    "roles": ["trustee"],
    "type": "company",
    "subType": "none",
    "country": "AUS",
    "name": "Smith Trustee Pty Ltd",
    "industry": "Trustee Services",
    "website": "https://smithtrustee.com.au",
    "identifiers": {
      "acn": "123456789",
      "abn": "98765432101"
    },
    "addresses": {
      "registeredAddress": "Level 5, 100 Collins St, Melbourne VIC 3000",
      "principalPlaceOfBusiness": "Suite 10, 50 Bridge St, Sydney NSW 2000"
    },
    "submissionId": "sub-abc123",
    "createdAt": 1737254548899,
    "updatedAt": 1737254548899,
    "createdTime": "30/01/2026 14:00:00",
    "updatedTime": "30/01/2026 14:00:00"
  },
  "error": null
}

Error response (404)

{
  "timestamp": "2026-01-30T04:05:00.000Z",
  "serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
  "trace": "abc123-verification-trace",
  "path": "/v5/verifications/:trace/stakeholders/:stakeholderId",
  "pathParams": {
    "trace": "abc123-verification-trace",
    "stakeholderId": "invalid-stakeholder-id"
  },
  "statusCode": 404,
  "message": "Not found",
  "help": null,
  "status": "error",
  "data": null,
  "error": {
    "type": "not_found",
    "details": [
      {
        "message": "Stakeholder not found",
        "code": "not_found",
        "path": ["stakeholderId"]
      }
    ]
  }
}

Stakeholder roles

Stakeholders can hold one or more of the following roles:

RoleDescription
applicantSubmits the application on behalf of the entity
directorBoard member governing the company
trusteeHolds and manages the Trust assets for the Beneficiaries
settlorEstablished the Trust by settling the initial assets
beneficiaryEntitled to benefit from the Trust
shareholderHolds shares in the company
partnerShares ownership and control of the Partnership
beneficialOwnerPerson who owns or controls 25% or more of the entity
appointorHas the power to appoint or remove the Trustee
guardianConsent required for certain Trustee decisions
protectorOversees the Trustee and may veto or direct certain Trustee decisions
principalNamed in the Trust Deed to appoint or remove the Trustee
chairpersonChairs the entity's governing body
presidentLeads the organisation's governing committee
ceoManages the entity's day-to-day operations
publicOfficerResponsible for the entity's statutory and tax obligations
treasurerResponsible for the organisation's finances
secretaryResponsible for the entity's records and statutory filings
unitHolderHolds units in the Unit Trust
otherAny other type of owner or controller of the entity

What's next?

Now that you know how to list and retrieve stakeholders, explore Include stakeholders to learn how to add stakeholders when creating a verification, or see the full Stakeholders API reference for updating stakeholder requests.

Was this page helpful?