> ## 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 an Entry > Use this endpoint to create a new Pix entry associated with an account and its data. This service does not perform the following validations and assumes they have been completed by the client before making the request: - **Receita Federal Validation**: The service does not validate data with Receita Federal. It is assumed that the client has already performed the necessary validation with a properly contracted provider integrated to RFB APIs. - **MFA Ownership Authentication**: The service assumes that Multi-Factor Authentication (MFA) for ownership verification has been previously completed before the request is made. ## OpenAPI ````yaml /en/openapi/v3-current/indirect-pix.yaml post /v1/dict/entries openapi: 3.0.3 info: title: Plugin BR Pix Indirect - Complete API description: | Complete API for Brazilian Pix instant payment system including Pix key dictionary operations, QR code generation/decoding, transactions and transaction limits. version: 1.0.0 servers: - url: https://plugin-pix-indirect.api.lerian.net security: - bearerAuth: [] paths: /v1/dict/entries: post: tags: - DICT API summary: Create an Entry description: |- Use this endpoint to create a new Pix entry associated with an account and its data. This service does not perform the following validations and assumes they have been completed by the client before making the request: - **Receita Federal Validation**: The service does not validate data with Receita Federal. It is assumed that the client has already performed the necessary validation with a properly contracted provider integrated to RFB APIs. - **MFA Ownership Authentication**: The service assumes that Multi-Factor Authentication (MFA) for ownership verification has been previously completed before the request is made. parameters: - $ref: '#/components/parameters/XAccountId' - $ref: '#/components/parameters/XReasonCreate' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateEntryInput' example: keyType: EMAIL key: john.doe@example.com responses: '201': description: Pix entry created successfully. content: application/json: schema: $ref: '#/components/schemas/EntryObject' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: ErrorPIX0001: $ref: '#/components/examples/ErrorPIX0001' ErrorPIX0002: $ref: '#/components/examples/ErrorPIX0002' ErrorPIX0003: $ref: '#/components/examples/ErrorPIX0003' ErrorPIX0004: $ref: '#/components/examples/ErrorPIX0004' ErrorPIX0005: $ref: '#/components/examples/ErrorPIX0005' ErrorPIX0006: $ref: '#/components/examples/ErrorPIX0006' ErrorPIX0012: $ref: '#/components/examples/ErrorPIX0012' ErrorPIX0101: $ref: '#/components/examples/ErrorPIX0101' ErrorPIX0102: $ref: '#/components/examples/ErrorPIX0102' ErrorPIX0105: $ref: '#/components/examples/ErrorPIX0105' ErrorPIX0106: $ref: '#/components/examples/ErrorPIX0106' ErrorPIX0107: $ref: '#/components/examples/ErrorPIX0107' ErrorPIX0108: $ref: '#/components/examples/ErrorPIX0108' ErrorPIX0109: $ref: '#/components/examples/ErrorPIX0109' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: ErrorPIX0103: $ref: '#/components/examples/ErrorPIX0103' ErrorPIX0110: $ref: '#/components/examples/ErrorPIX0110' ErrorPIX0111: $ref: '#/components/examples/ErrorPIX0111' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: ErrorPIX0114: $ref: '#/components/examples/ErrorPIX0114' ErrorPIX0165: $ref: '#/components/examples/ErrorPIX0165' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: ErrorPIX0000: $ref: '#/components/examples/ErrorPIX0000' ErrorPIX0500: $ref: '#/components/examples/ErrorPIX0500' ErrorPIX0599: $ref: '#/components/examples/ErrorPIX0599' '502': description: Bad Gateway content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: ErrorPIX1000: $ref: '#/components/examples/ErrorPIX1000' ErrorPIX1007: $ref: '#/components/examples/ErrorPIX1007' ErrorPIX1099: $ref: '#/components/examples/ErrorPIX1099' deprecated: false security: - bearerAuth: [] components: parameters: XAccountId: name: X-Account-Id in: header description: Unique identifier of the Midaz Ledger Account (UUID format). required: true example: 019c96a0-0a98-7287-9a31-786e0809c769 schema: type: string XReasonCreate: name: X-Reason in: header description: Reason for creating the entry. required: true example: USER_REQUESTED schema: type: string enum: - USER_REQUESTED - RECONCILIATION schemas: CreateEntryInput: type: object required: - keyType properties: keyType: description: Type of Pix key being created. type: string enum: - EMAIL - PHONE - CPF - CNPJ - EVP example: EMAIL key: description: |- Pix key value being registered (e.g., email address, phone, or CPF). Not required for EVP type. type: string example: john.doe@example.com metadata: description: Optional key-value map for storing custom attributes. type: object additionalProperties: {} EntryObject: type: object properties: id: type: string description: Unique identifier of the entry (UUID format). example: 019c96a0-0c0c-7221-8cf3-13313fb60081 key: type: string description: Pix key value. example: john.doe@example.com keyType: type: string description: Type of Pix key. example: EMAIL status: type: string description: Entry status (ACTIVE, INACTIVE). example: ACTIVE account: $ref: '#/components/schemas/AccountDetails' owner: $ref: '#/components/schemas/OwnerDetails' createdAt: type: string format: date-time description: Creation timestamp. example: '2024-01-15T10:30:00Z' updatedAt: type: string format: date-time description: Last update timestamp. example: '2024-01-15T10:30:00Z' ErrorFormat: type: object description: The response message error. required: - code - title - message properties: code: type: string description: A unique, stable identifier for the error. title: type: string description: A brief summary of the issue. message: type: string description: Detailed guidance for resolving the error. AccountDetails: type: object properties: branch: type: string description: Bank branch code. example: '0001' number: type: string description: Account number. example: '123456789' participant: type: string description: ISPB of the participant institution. example: '12345678' type: type: string description: Account type. example: TRAN OwnerDetails: type: object properties: name: type: string description: Owner name. example: John Doe taxIdNumber: type: string description: CPF or CNPJ. example: '12345678901' type: type: string enum: - NATURAL_PERSON - LEGAL_PERSON description: Owner type. example: NATURAL_PERSON examples: ErrorPIX0001: summary: Missing Headers in Request value: code: PIX-0001 title: Missing Headers in Request message: >- Your request is missing one or more required header params. Please refer to the documentation to ensure all necessary header params are included in your request. ErrorPIX0002: summary: Invalid Header Value value: code: PIX-0002 title: Invalid Header Value message: >- One or more header values are invalid. Please refer to the documentation to verify the expected format and allowed values for each header. ErrorPIX0003: summary: Missing Fields in Request value: code: PIX-0003 title: Missing Fields in Request message: >- Your request is missing one or more required fields. Please refer to the documentation to ensure all necessary fields are included in your request. ErrorPIX0004: summary: Invalid Field Values in Request value: code: PIX-0004 title: Invalid Field Values in Request message: >- Your request contains one or more fields with invalid values. Please refer to the documentation to verify that all fields have the correct values. ErrorPIX0005: summary: Invalid Field Type in Request value: code: PIX-0005 title: Invalid Field Type in Request message: >- Your request contains one or more fields with an invalid data type. Please refer to the documentation to verify that all fields have the correct type. ErrorPIX0006: summary: Unexpected Fields in Request value: code: PIX-0006 title: Unexpected Fields in Request message: >- The request body contains more fields than expected. Please send only the allowed fields as per the documentation. ErrorPIX0012: summary: Invalid Metadata value: code: PIX-0012 title: Invalid Metadata message: >- The metadata is invalid. Please refer to the documentation to verify the expected format. ErrorPIX0101: summary: EVP Key Cannot Be Provided value: code: PIX-0101 title: EVP Key Cannot Be Provided message: >- EVP keys cannot be provided manually, they are automatically generated. ErrorPIX0102: summary: Invalid Key Format value: code: PIX-0102 title: Invalid Key Format message: Invalid format for the specified keyType. ErrorPIX0105: summary: CPF Mismatch value: code: PIX-0105 title: CPF Mismatch message: CPF does not match holder document in CRM. ErrorPIX0106: summary: CNPJ Mismatch value: code: PIX-0106 title: CNPJ Mismatch message: CNPJ does not match holder document in CRM. ErrorPIX0107: summary: Pix Key Limit Exceeded for Holder value: code: PIX-0107 title: Pix Key Limit Exceeded for Holder message: The key limit has been exceeded for the holder. ErrorPIX0108: summary: Pix Key Limit Exceeded for Type value: code: PIX-0108 title: Pix Key Limit Exceeded for Type message: The key type limit has been exceeded. ErrorPIX0109: summary: Invalid Opening Date value: code: PIX-0109 title: Invalid Opening Date message: >- The opening date in CRM is invalid. Please provide a valid date in the 'yyyy-mm-dd' format. ErrorPIX0103: summary: Pix Key Already Exists value: code: PIX-0103 title: Pix Key Already Exists message: The Pix key is already registered. ErrorPIX0110: summary: Pix Key Belongs to Another Holder value: code: PIX-0110 title: Pix Key Belongs to Another Holder message: >- The Pix key is already registered to another holder. Please initiate an ownership claim to acquire this key. ErrorPIX0111: summary: Pix Key Already Linked to Another Account value: code: PIX-0111 title: Pix Key Already Linked to Another Account message: >- The Pix key is already linked to another account of the same holder. Please initiate a portability request to transfer this key. ErrorPIX0114: summary: Key In Custody Account value: code: PIX-0114 title: Key In Custody Account message: The entry queried is in custody of the participant making the query. ErrorPIX0165: summary: Entry Inactive value: code: PIX-0165 title: Entry Inactive message: The entry is not in active status. ErrorPIX0000: summary: Internal Server Error value: code: PIX-0000 title: Internal Server Error message: The server encountered an unexpected error. Please try again later. ErrorPIX0500: summary: CRM Connection Error value: code: PIX-0500 title: CRM Connection Error message: Failed to connect to CRM service. ErrorPIX0599: summary: CRM Bad Request value: code: PIX-0599 title: CRM Bad Request message: CRM returned a bad request error. ErrorPIX1000: summary: Provider Connection Error value: code: PIX-1000 title: Provider Connection Error message: Failed to connect to provider. ErrorPIX1007: summary: Provider Internal Error value: code: PIX-1007 title: Provider Internal Error message: Provider returned an internal error. ErrorPIX1099: summary: Provider Unmapped Error value: code: PIX-1099 title: Provider Unmapped Error message: Provider returned an unmapped error. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````