Taifa Identity. Docs
OpenAPI Developers

API reference

Proof

Management API contract View .md

POST/v1/institutions/{institution_id}/account-proofs

Authentication Bearer access token with audience taifa-management. Roles and local eligibility are reviewed separately from the OpenAPI bearer scheme.

Parameters

NameInTypeRequiredDescription
institution_idpathstringYes
idempotency-keyheaderstringYes

Request body

application/jsonRequiredProofCreate

FieldTypeRequiredDescription
reasonstringYesValidation: min length 8; max length 500
evidence_referencestringYesValidation: min length 5; max length 500
project_idstringYes
person_idstringYes
local_account_idstringYesValidation: min length 1; max length 200
expires_in_minutesintegerNoValidation: minimum 1; maximum 60

Responses

201Successful Response

Content type: application/jsonUnspecified response schema

No fields declared in the current specification.

Other responses

StatusDescriptionSchema
422Validation ErrorHTTPValidationError

Request example

Illustrative only. TypeScript runs in Node.js on the server. Keep management tokens out of browser bundles. Replace the host, token, path values, and any header or required body placeholders before use. Examples do not send requests.

Shell
curl -X POST 'https://YOUR_IDENTITY_HOST/v1/institutions/REPLACE_WITH_INSTITUTION_ID/account-proofs' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'idempotency-key: REPLACE_WITH_IDEMPOTENCY_KEY' \
  -H 'Content-Type: application/json' \
  --data '{
  "reason": "REPLACE_WITH_REASON",
  "evidence_reference": "REPLACE_WITH_EVIDENCE_REFERENCE",
  "project_id": "REPLACE_WITH_PROJECT_ID",
  "person_id": "REPLACE_WITH_PERSON_ID",
  "local_account_id": "REPLACE_WITH_LOCAL_ACCOUNT_ID"
}'

Response example

No response example in the current specification.

Popular

Browse by section