> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Create a Pix key entry > Registers a new Pix key entry in the DICT directory. Assumes Receita Federal validation and MFA ownership authentication were completed by the client before the request. ## OpenAPI ````yaml /es/openapi/v3-current/pix-lerian-dict.yaml post /entries openapi: 3.1.0 info: contact: name: Lerian Studio url: https://lerian.studio description: >- Public API for Pix keys, claims, fraud markers, infraction reports, and MED funds recovery. This release provides a mock-provider integration for testing; live BACEN connectivity is not included. license: name: Lerian Studio General License title: Pix Lerian — DICT version: 1.0.0 servers: - url: https://api.example.com/dict-hub/v1 description: >- Replace the example host with the URL provided during environment onboarding. security: - BearerAuth: [] tags: - description: Manage ownership and portability claims for Pix keys. name: Claims - description: Register, retrieve, list, update, and remove Pix keys. name: Entries - description: Create, query, list, and cancel DICT fraud markers. name: Fraud Markers - description: Manage participant-scoped MED 2.0 funds recoveries. name: Funds Recoveries - description: Manage MED 2.0 infraction reports for the authenticated organization. name: Infraction Reports - description: Look up Pix keys and check whether keys exist in the DICT directory. name: Keys - description: Create, query, cancel, and settle MED 2.0 refunds. name: Refunds paths: /entries: post: tags: - Entries summary: Create a Pix key entry description: >- Registers a new Pix key entry in the DICT directory. Assumes Receita Federal validation and MFA ownership authentication were completed by the client before the request. operationId: createEntry parameters: - description: >- REQUIRED. Client-supplied replay key, at most 64 bytes. A request without it is refused with PIX-0030 @ 400 before the handler runs. Replaying the same key with a divergent method, URL or body is PIX-0031 @ 412. in: header name: X-Idempotency required: true schema: maxLength: 64 minLength: 1 type: string - description: Account ID (UUID format) in: header name: X-Account-Id required: true schema: description: Account ID (UUID format) examples: - 019606a1-3b4c-7d8e-9f01-234567890abc type: string - description: 'Reason for creating the entry: USER_REQUESTED or RECONCILIATION' in: header name: X-Reason required: true schema: description: 'Reason for creating the entry: USER_REQUESTED or RECONCILIATION' examples: - USER_REQUESTED type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEntryBody' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateEntryOutput' description: Created '400': content: application/json: example: code: PIX-0030 title: Idempotency Key Required message: >- The Idempotency-Key header is required for this operation and must be within the accepted length. schema: $ref: '#/components/schemas/LegacyErrorEnvelope' application/problem+json: example: type: https://errors.lerian.studio/v1/PIX-0001 title: Bad Request status: 400 detail: Your request is missing one or more required header params. code: PIX-0001 schema: $ref: '#/components/schemas/Detail' description: >- Bad Request (PIX-0001, PIX-0002, PIX-0003, PIX-0017, PIX-0015, PIX-0020, PIX-0103). X-Idempotency absent or longer than 64 bytes (PIX-0030). Legacy {code,title,message} envelope, NOT problem+json. '409': content: application/problem+json: example: type: https://errors.lerian.studio/v1/PIX-0102 title: Conflict status: 409 detail: Key value is already registered. code: PIX-0102 schema: $ref: '#/components/schemas/Detail' description: Conflict (PIX-0102). '412': content: application/json: example: code: PIX-0031 title: Idempotency Key Conflict message: The Idempotency-Key was already used with a different request. schema: $ref: '#/components/schemas/LegacyErrorEnvelope' description: >- X-Idempotency replayed with a divergent request -- a different method, URL (including the path parameter), body, or identity header among X-Account-Id / X-Reason / X-End-To-End-Id (PIX-0031). Legacy {code,title,message} envelope, NOT problem+json. '422': content: application/problem+json: example: type: https://errors.lerian.studio/v1/PIX-0100 title: Unprocessable Entity status: 422 detail: Missing or malformed required fields. code: PIX-0100 schema: $ref: '#/components/schemas/Detail' description: Unprocessable Entity (PIX-0100, PIX-0149, PIX-0116). '500': content: application/problem+json: example: type: https://errors.lerian.studio/v1/PIX-0000 title: Internal Server Error status: 500 detail: internal error code: PIX-0000 schema: $ref: '#/components/schemas/Detail' description: Internal Server Error (PIX-0000). '502': content: application/problem+json: example: type: https://errors.lerian.studio/v1/PIX-0140 title: Bad Gateway status: 502 detail: internal error code: PIX-0140 schema: $ref: '#/components/schemas/Detail' description: Bad Gateway (PIX-0140, PIX-0141). '503': content: application/json: example: code: PIX-0032 title: Idempotency Unavailable message: >- The request was not processed because the idempotency store is unavailable. Please retry. schema: $ref: '#/components/schemas/LegacyErrorEnvelope' description: >- Replay cache unavailable on this fail-closed route, so the mutation was refused rather than executed without replay protection (PIX-0032). Legacy {code,title,message} envelope, NOT problem+json. default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error components: schemas: CreateEntryBody: additionalProperties: false properties: keyType: description: Pix key type examples: - CPF type: string keyValue: description: Pix key value examples: - '52998224725' type: string metadata: additionalProperties: {} description: >- Free-form, single-level key/value pairs persisted with the entry. Keys up to 100 characters, values up to 2000 characters, at most 25 entries; nested objects are rejected. examples: - source: mobile maxProperties: 25 type: object required: - keyType type: object CreateEntryOutput: additionalProperties: false properties: account: $ref: '#/components/schemas/EntryAccountOutput' createdAt: examples: - '2019-11-18T03:00:00Z' format: date-time type: string holderId: examples: - 019606e5-7f80-9102-3d45-678901234ef0 type: string id: examples: - 019606c3-5d6e-7f80-1b23-456789012cde type: string keyCreationDate: examples: - '2019-11-18T03:00:00Z' format: date-time type: string keyOwnershipDate: examples: - '2019-11-18T03:00:00Z' format: date-time type: string keyType: examples: - CPF type: string keyValue: examples: - '52998224725' type: string metadata: additionalProperties: {} type: object organizationId: examples: - 019606d4-6e7f-8091-2c34-567890123def type: string owner: $ref: '#/components/schemas/EntryOwnerOutput' requestId: examples: - a946d533-7f22-42a5-9a9b-e87cd55c0f4d type: string status: examples: - ACTIVE type: string updatedAt: examples: - '2019-11-18T03:00:00Z' format: date-time type: string required: - id - organizationId - holderId - keyType - keyValue - status - requestId - keyCreationDate - keyOwnershipDate - account - owner - createdAt - updatedAt type: object LegacyErrorEnvelope: additionalProperties: false properties: code: description: PIX-XXXX error code type: string message: description: Human-readable error message type: string title: description: Short error title type: string required: - code - title - message type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). examples: - ERR-0001 type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object EntryAccountOutput: additionalProperties: false properties: branch: examples: - '0001' type: string number: examples: - '0007654321' type: string openingDate: examples: - '2010-01-10T03:00:00Z' format: date-time type: string participant: examples: - '12345678' type: string type: examples: - CACC type: string required: - branch - number - type - participant type: object EntryOwnerOutput: additionalProperties: false properties: document: examples: - '52998224725' type: string name: examples: - João Silva type: string personType: examples: - NATURAL type: string tradeName: examples: - Silva ME type: string required: - document - personType - name type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ````