HYBRID-CHAINDEVELOPERS
DOCUMENTATIONv2
POST

Authentication

Register account

/api/v2/registrations
AUTHENTICATIONNone · publicAUTHORITATIVE OWNERidentity-access · identity-serviceCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

Create an inactive tenant-bound account with server-side password hashing, versioned terms acceptance, and encrypted activation delivery.

WHEN THIS CALL IS USEFUL

Use for first-party personal or corporate account creation after the application has resolved the tenant brand, current legal terms, and the correct account type.

OUTCOME · Create or advance

What changes

Creates an inactive Identity account, password verifier, versioned terms-acceptance record, and encrypted 24-hour activation delivery. It does not create an authenticated session.

WHY IT MATTERS

  • Gives people and agents a contract-backed way to advance account.
  • Makes credential and account-lifecycle transitions explicit while keeping passwords, authenticator secrets, recovery codes, refresh tokens, devices, sessions, and account state under separate controls.

ISOLATION + AUTHORITY

Tenant identity, profile, password, authenticator enrollment, recovery code, device, session, access token, refresh credential, step-up grant, and account-closure state remain distinct. Authentication proves only the admitted session and scopes; it grants no workspace role, wallet, payment, settlement, publisher, matching, or trading authority.

BEFORE YOU CALL

  • No bearer credential is required; apply bounded filters and canonical public identifiers where the contract provides them.
  • Supply the required account_type (body), email (body), password (body), terms (body) exactly as defined by the live contract.
  • Resolve the tenant, account lifecycle, client device, credential state, authenticator or recovery basis, and required step-up purpose for this security transition.

WHAT TO DO NEXT

  • Continue through the separately evidenced activation flow before treating the account as active or issuing an authenticated session.
  • Bind later workspace membership and role assignment independently; registration alone grants no resource or administrative authority.

AGENT GUIDANCE

  • Use account only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
  • Supply the required account_type (body), email (body), password (body), terms (body) exactly as defined by the live contract.
  • Keep registration, activation, credential verification, session issuance, refresh rotation, authenticator enrollment, confirmation, recovery, revocation, and account closure as separate lifecycle transitions.
  • After a timeout or conflict, read authoritative state before deciding whether an equivalent retry is safe.
MACHINE CONTRACT

The exact deployed parameters, schemas, responses, security requirements, and Hybrid-Chain agent metadata are authoritative at this operation's production OpenAPI JSON Pointer. The readable tables below add integration guidance; the deployed OpenAPI controls if guidance and the machine contract ever differ.

Open the authoritative production contract

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE
tenant_uuidbodyOptional

tenant identifier · 1–128Tenant or white-label registration boundary; omission selects global.

account_typebodyRequired

personal | corporateControls conditional identity fields: personal requires first_name and last_name; corporate requires company_name.

emailbodyRequired

email address · max 128Normalized login and activation-delivery address.

passwordbodyRequired

printable string · 12–128Must use at least three character classes and must not contain an email local part of four or more characters.

company_namebodyOptional

string · 1–160Required for corporate accounts; not used for personal accounts.

first_namebodyOptional

string · 1–100Required for personal accounts.

middle_namebodyOptional

string · max 100Optional personal middle name.

last_namebodyOptional

string · 1–100Required for personal accounts.

terms.acceptedbodyRequired

trueExplicit acceptance; false or omission is rejected.

terms.versionbodyRequired

published version · max 64Exact current terms version accepted by the registrant.

terms.privacy_policy_versionbodyOptional

published version · max 64Exact privacy-policy version when published separately.

REQUEST

JSON body example

{
  "tenant_uuid": "global",
  "account_type": "personal",
  "email": "[email protected]",
  "password": "Correct-Horse#2048",
  "first_name": "Ada",
  "last_name": "Lovelace",
  "terms": {
    "accepted": true,
    "version": "2026-08",
    "privacy_policy_version": "2026-08"
  }
}

STABLE ERROR CODES

Branch on the code, then follow the recovery action

These codes are published by the authoritative gateway contract for this endpoint. Treat message as safe diagnostic text; integrations should branch on code and HTTP status.

STATUSCODEMEANING
400invalid_jsonThe JSON body is malformed or fails the published account schema.
400invalid_security_requestThe account lifecycle request is invalid.
400missing_idempotency_keyA nonempty Idempotency-Key is required for this mutation.
401invalid_credentialsThe bearer, password, activation, or reset credential is invalid.
403step_up_requiredFresh purpose-bound authenticator verification is required.
404account_closure_not_foundThe account closure request was not found.
409security_conflictThe requested account transition conflicts with current security state.
409account_closure_conflictThe account closure transition conflicts with current lifecycle state.
503identity_security_unavailableThe authoritative Identity security service is temporarily unavailable.

RESPONSES

Status and payload examples

201Inactive account and encrypted activation delivery created.Mutation completed · JSON RESPONSE+
{
  "registration_id": "f8317aef81764e1f923037c1b76df8de",
  "client_id": "hcu_…",
  "tenant_uuid": "global",
  "status": "PENDING_ACTIVATION",
  "activation_delivery": "email",
  "activation_expires_at": "2026-09-02T12:00:00Z"
}
INTEGRATION DECISION
CALLER ACTION
Accept the returned representation or receipt, then continue through the separately evidenced activation flow before treating the account as active or issuing an authenticated session.
RETRY SAFETY
Do not repeat a successful mutation merely to confirm it. This mutation has no documented idempotent replay contract. Reconcile state before considering another attempt.
STATE RECONCILIATION
Persist returned identifiers, versions, commitments, and receipts. Refresh the relevant account, session, authenticator, client, key, or one-time transaction state; replace consumed or expired credentials instead of replaying them.
400The account shape, conditional fields, password, or terms acceptance is invalid.Request must change · JSON RESPONSE+
{
  "code": "invalid_security_request",
  "message": "The account shape, conditional fields, password, or terms acceptance is invalid."
}
INTEGRATION DECISIONinvalid_security_request
CALLER ACTION
Rebuild the request from the live OpenAPI operation and correct the rejected method, media type, header, parameter, or body field.
RETRY SAFETY
Do not retry the same invalid request. This mutation has no documented idempotent replay contract. Reconcile state before considering another attempt.
STATE RECONCILIATION
Compare the submitted values with the documented constraints before another call. Refresh the relevant account, session, authenticator, client, key, or one-time transaction state; replace consumed or expired credentials instead of replaying them.
ESCALATE WHEN
Escalate when account or tenant binding, session revocation, authenticator state, key rotation, or one-time-token consumption cannot be reconciled securely.
403Registration is not available for the selected tenant.Authority or policy denied · JSON RESPONSE+
{
  "code": "step_up_required",
  "message": "Registration is not available for the selected tenant."
}
INTEGRATION DECISIONstep_up_required
CALLER ACTION
Verify the exact scope, tenant or workspace membership, owner boundary, step-up purpose, feature policy, and resource eligibility. Never broaden authority automatically.
RETRY SAFETY
Do not retry until the missing authority or policy condition has been deliberately resolved with least privilege.
STATE RECONCILIATION
Confirm the caller and resource resolve to the same authority boundary for accounts, activations, sessions, authenticators, step-up grants, workload identities, keys, and revocations.
ESCALATE WHEN
Escalate when account or tenant binding, session revocation, authenticator state, key rotation, or one-time-token consumption cannot be reconciled securely.
409An active or trashed account already exists for this email and tenant.State reconciliation required · JSON RESPONSE+
{
  "code": "security_conflict",
  "message": "An active or trashed account already exists for this email and tenant."
}
INTEGRATION DECISIONsecurity_conflict
CALLER ACTION
Stop the mutation sequence and fetch the latest authoritative resource, lifecycle state, version, ETag, reservation, or existing idempotency result.
RETRY SAFETY
Retry only after reconciling the conflict. This mutation has no documented idempotent replay contract. Reconcile state before considering another attempt.
STATE RECONCILIATION
Refresh the relevant account, session, authenticator, client, key, or one-time transaction state; replace consumed or expired credentials instead of replaying them.
ESCALATE WHEN
Escalate when account or tenant binding, session revocation, authenticator state, key rotation, or one-time-token consumption cannot be reconciled securely.
503Identity or encrypted activation delivery is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+
{
  "code": "identity_security_unavailable",
  "message": "Identity or encrypted activation delivery is unavailable."
}
INTEGRATION DECISIONidentity_security_unavailable
CALLER ACTION
Preserve the exact request and treat the outcome as uncertain until authoritative state proves whether it committed.
RETRY SAFETY
Reconcile before retrying. This mutation has no documented idempotent replay contract. Reconcile state before considering another attempt. Use bounded backoff with jitter.
STATE RECONCILIATION
Refresh the relevant account, session, authenticator, client, key, or one-time transaction state; replace consumed or expired credentials instead of replaying them.
ESCALATE WHEN
Escalate when account or tenant binding, session revocation, authenticator state, key rotation, or one-time-token consumption cannot be reconciled securely.

OPERATIONAL NOTES

Security and lifecycle guarantees

  • Registration creates PENDING_ACTIVATION state, not a login session. Complete activation and then create a session.
  • The activation token is delivered out of band and never appears in this response. Re-registering an unactivated account queues a new activation transaction.
  • Never log the password, delivery payload, or later activation token.

UPGRADING FROM V1

Legacy calls replaced by this operation

If you maintain an older integration, use this map to find the V2 replacement. Do not translate the old request field-for-field: rebuild it from the V2 parameters and schemas above because identity, authorization, replay protection, and response semantics may have changed.

POST/api/v1/auth/registrationAUTH: Register a Private User
DOCUMENTATION STATUS

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-09-11T06:35:11.572Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation Return to the V2 directory