/v1/partner-profileReturn the authenticated application, organisation, capabilities and scopes.
partner_profile:read200Family A
/v1/organizationsPartner & organisation APIs
Register partner applications, resolve legal organisations and preserve namespaced identifiers without creating duplicate trading identities.
Designed for: Trade platforms, institutions, registries and any partner onboarding an organisation
MethodEndpointScopeSuccess
/v1/organizationsResolve an existing organisation or register a new canonical identity.
organizations:write200 / 201/v1/organizations/{organization_id}Return the permitted organisation projection.
organizations:read200/v1/organizations/{organization_id}Update permitted trading-profile facts using optimistic concurrency.
organizations:write200/v1/organizations/{organization_id}/identifiersAdd a namespaced external identifier for resolution and reconciliation.
organizations:write201/v1/organizations/{organization_id}/capabilitiesList certified capabilities available to this organisation.
organizations:read200/v1/partner-connectionsRequest or register a governed connection between partner organisations.
partner_connections:write202Postman example
Resolve or create an organisation
POST {{base_url}}/v1/organizations
X-TradeVow-API-Key: {{api_key}}
Content-Type: application/json
Idempotency-Key: {{$guid}}
X-Correlation-ID: {{$guid}}Domain rules
- TradeVow assigns the canonical opaque ID.
- External identifiers are namespaced aliases, never primary keys.
- Partner application identity remains distinct from the legal trading organisation.
- Matching uncertainty creates a review action; it does not silently merge records.
Related events
organization.createdorganization.identity_status_changedorganization.capability_changedpartner_connection.status_changed