List of Director ID & Other Jurisdiction ID

GET {{baseUrl}}/contacts/{{contactId}}/ids

Allows you to retrieve all IDs (e.g. Director ID) for an individual contact.

API SCOPES

The following [API scopes] can access this resource

  • cas_incorporator
  • bgl_partner

RESPONSE ID TYPES:

  • AUSTRALIANDIRECTORID
  • CHINA_ID
  • EMPLOYMENT_PASS
  • HONGKONGID
  • MACAU_ID
  • MALAY_IC
  • OTHER
  • SINGAPORE_FIN
  • SINGAPORENRICCITIZEN
  • SINGAPORENRICPR

RESPONSE

KeyTypeComments
idnumberid
typeStringid type.
See list of id types above.
valueStringid value

Request Params

KeyDatatypeRequiredDescription
addressesboolean

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Content-Typestring
``null

RESPONSES

status: OK

{"ids":[{"id":3436,"type":"AUSTRALIAN_DIRECTOR_ID","value":"000000000000000"},{"id":3732,"type":"OTHER","value":"000000000000000"}]}