> ## Documentation Index > Fetch the complete documentation index at: https://docs.enfinitos.com/llms.txt > Use this file to discover all available pages before exploring further. # Register a counterparty > Register a new counterparty. Settlement-rule splits address counterparties by id, so these must exist before a rule can target them. `jurisdiction` and `defaultCurrency` are upper-cased before validation. Requires scope `settlement:write`. ## OpenAPI ````yaml /openapi-v1.yaml post /v1/counterparties openapi: 3.1.0 info: title: EnfinitOS API version: v1.0 description: >- The governed-execution `/v1` developer API for EnfinitOS — rights, delivery, proof, and settlement. Use this API to register the legal **bases** a right rests on, **issue** and lifecycle-manage rights across delivery substrates (DOOH, CTV, spatial/AR, mobile, audio, and more), negotiate **offers**, raise and resolve **challenges**, observe constraint-gated **deliveries**, seal signed **proof packs**, read **metering** + **settlement** projections, configure settlement **rules** and **counterparties**, fulfil GDPR **compliance** requests, and subscribe to **webhooks**. Every state-changing action is appended to an immutable, signable audit log; delivery and proof artefacts are Ed25519-signed so a downstream auditor can verify them offline. ## Response envelope Every response wraps its payload in a canonical envelope. Success (HTTP 200): ```json { "ok": true, "data": { ... }, "contractVersion": "v1.0" } ``` Error (4xx / 5xx): ```json { "ok": false, "error": "VALIDATION_FAILED", "message": "human text", "contractVersion": "v1.0" } ``` Some error responses carry additional context fields alongside `error` and `message` (for example `field`, `validationErrors`, `requiredScopes`, `keyScopes`). ## Authentication All endpoints except `GET /v1` and `GET /v1/healthz` require an API key sent as `Authorization: Bearer `. Keys carry a set of named scopes; each operation documents the scope it requires. A key carrying the `*` wildcard scope passes every scope check. Pre-launch, sandbox keys are issued through the apply flow: request access at `/apply`, receive an activation email on approval, and exchange it for a `/v1` sandbox key in the integration playground at `/developers/playground`. Self-service key issuance from the developer dashboard at `/developers/dashboard` lands at the April 2027 production launch. ## Identifiers Resource ids are prefixed: bases `bas_…`, rights `rgh_…`, offers `ofr_…` (passed as `rightId`/`offerId`), settlement rules `rule_…`, counterparties `cp_…`, webhook subscriptions, and webhook deliveries `dlv_…`. All timestamps are ISO-8601 strings. contact: name: EnfinitOS Developer Support url: https://docs.enfinitos.com email: developers@enfinitos.com servers: - url: https://sandbox.api.enfinitos.com description: Sandbox — live today - url: https://api.enfinitos.com description: Production — at the April 2027 launch security: - bearerAuth: [] tags: - name: Discovery description: Unauthenticated contract + health probes. - name: Tenant description: Read the caller's sandbox tenant snapshot. - name: Rights description: Bases and the right lifecycle (issue, suspend, resume, revoke). - name: Offers description: Propose, accept, reject, counter, and withdraw offers. - name: Challenges description: Open, resolve, and withdraw challenges against rights. - name: Delivery description: Observe constraint-gated delivery events. - name: Audit description: The append-only event log. - name: Proof description: Signed proof packs. - name: Metering & Settlement description: Metering and settlement projections. - name: Settlement config description: Settlement rules and counterparties. - name: Compliance description: GDPR Article 15 export and Article 17 erasure. - name: Webhooks description: Webhook subscriptions and delivery history. - name: Disputes description: Delivery disputes — open, investigate, respond, resolve. paths: /v1/counterparties: post: tags: - Settlement config summary: Register a counterparty description: >- Register a new counterparty. Settlement-rule splits address counterparties by id, so these must exist before a rule can target them. `jurisdiction` and `defaultCurrency` are upper-cased before validation. Requires scope `settlement:write`. operationId: createCounterparty requestBody: required: true content: application/json: schema: type: object required: - kind - taxTreatment - legalName - displayName - jurisdiction - defaultCurrency properties: kind: $ref: '#/components/schemas/CounterpartyKind' taxTreatment: $ref: '#/components/schemas/TaxTreatment' legalName: type: string displayName: type: string jurisdiction: type: string description: ISO 3166-1 alpha-2 country code (upper-cased). defaultCurrency: type: string description: ISO 4217 currency code (upper-cased). taxId: type: - string - 'null' taxWithholdingRate: type: - string - 'null' description: Decimal string, e.g. "0.15". ledgerAccountCode: type: - string - 'null' tags: type: array items: type: string active: type: boolean default: true responses: '200': description: The created counterparty. content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessEnvelope' - type: object properties: data: type: object properties: counterparty: $ref: '#/components/schemas/Counterparty' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '422': $ref: '#/components/responses/ValidationFailed' components: schemas: CounterpartyKind: type: string enum: - VENUE - CUSTOMER - AGENCY - AFFILIATE - RESELLER - TAX_AUTHORITY TaxTreatment: type: string enum: - STANDARD_VAT - ZERO_RATED - EXEMPT - REVERSE_CHARGE - NON_VAT_JURISDICTION SuccessEnvelope: type: object required: - ok - data - contractVersion properties: ok: type: boolean const: true data: description: Route-specific payload. Operation responses refine this. type: object contractVersion: type: string const: v1.0 Counterparty: type: object description: An identified entity the operator settles with. properties: id: type: string description: Prefixed `cp_`. orgId: type: string kind: $ref: '#/components/schemas/CounterpartyKind' legalName: type: string displayName: type: string jurisdiction: type: string description: ISO 3166-1 alpha-2 country code. taxId: type: - string - 'null' defaultCurrency: type: string description: ISO 4217 default settlement currency. taxWithholdingRate: type: - string - 'null' description: Per-counterparty withholding rate (decimal string). taxTreatment: $ref: '#/components/schemas/TaxTreatment' ledgerAccountCode: type: - string - 'null' tags: type: array items: type: string active: type: boolean preferredRole: oneOf: - $ref: '#/components/schemas/SettlementPartyRole' - type: 'null' createdAt: type: string format: date-time updatedAt: type: string format: date-time SettlementPartyRole: type: string enum: - TENANT - VENUE - CUSTOMER - PLATFORM - AGENCY - AFFILIATE - RESELLER - TAX_AUTHORITY ErrorEnvelope: type: object required: - ok - error - message properties: ok: type: boolean const: false error: $ref: '#/components/schemas/ErrorCode' message: type: string description: Human-readable explanation. contractVersion: type: string const: v1.0 field: type: string description: Present on some VALIDATION_FAILED errors — the offending field. validationErrors: type: array description: Present on settlement-rule / counterparty validation failures. items: type: object additionalProperties: true requiredScopes: type: array description: Present on SCOPE_MISSING — the scopes the operation needs. items: type: string keyScopes: type: array description: Present on SCOPE_MISSING — the scopes the presented key carries. items: type: string additionalProperties: true ErrorCode: type: string description: Machine-readable error code. Drives the HTTP status. enum: - AUTH_REQUIRED - AUTH_INVALID - SCOPE_MISSING - BAD_REQUEST - VALIDATION_FAILED - RESOURCE_NOT_FOUND - STATE_CONFLICT - PRECONDITION_FAILED - RATE_LIMITED - INTERNAL_ERROR responses: Unauthorized: description: >- Missing/malformed Authorization header (AUTH_REQUIRED) or an invalid key (AUTH_INVALID). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Forbidden: description: >- The key is valid but missing one or more required scopes (SCOPE_MISSING). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' ValidationFailed: description: >- A field was missing or wrong-typed (VALIDATION_FAILED). May carry `field` or `validationErrors`. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: bearerAuth: type: http scheme: bearer description: 'API key sent as `Authorization: Bearer `.' ````