Organisations
An organisation is the legal entity a credential is issued on behalf of. Issuers belong to organisations.
List
curl -sS "$BASE/v1/organisations" -H "Authorization: ApiKey $KEY"
Scope: organisations.read.
Read one
curl -sS "$BASE/v1/organisations/$ORGANISATION_REFERENCE" -H "Authorization: ApiKey $KEY"
Scope: organisations.read. An organisation in another tenant returns 404.
Create
curl -sS -X POST "$BASE/v1/organisations" \
-H "Authorization: ApiKey $KEY" \
-H "Content-Type: application/json" \
-d '{
"externalReference": "acme-ltd",
"displayName": "Acme Limited",
"legalName": "Acme Limited",
"tradingName": null,
"description": null,
"websiteUrl": null,
"countryCode": "NZ",
"registrationNumber": null
}'
Scope: organisations.manage. Returns 201, or 409 if externalReference is already used in your tenant.
externalReference is yours to choose and is the identifier you use in later calls. Pick something stable in
your own systems.
Fields
| Field | Notes |
|---|---|
externalReference |
Your stable identifier for this organisation |
displayName |
Shown in DiligenceID surfaces |
legalName |
The registered legal entity name |
status |
Active or Suspended. A suspended organisation cannot issue |
countryCode |
ISO 3166-1 alpha-2 |
rowVersion |
Concurrency token for updates |
Not yet available
Organisation verification and trust evidence — the chain that answers why an organisation is trusted, rather
than whether it exists — are programme work and are not exposed on /v1. Nothing in this API asserts that an
organisation has been verified against an authoritative register.