--- title: "Update key entry" method: PATCH path: "/v2/pix/keys" tags: ["Keys"] --- # Update key entry `PATCH /v2/pix/keys` Update the DICT key entry. On PSP timeout, a `202 Accepted` response with a key status = `PROCESSING` is returned and the process continues asynchronously, eventually emitting a success or error event. This endpoint generates a Pix key status changed event. ## Headers - `Authorization` string, required - `Idempotency-Key` string, required ## Request body - PresenterUpdateRequest - `key` string, required — Pix key value. - `key_type` 'CPF' | 'CNPJ' | 'PHONE' | 'EMAIL' | 'EVP', required — User information that can be used to create a Pix key: * `CPF` - Cadastro de Pessoas Fisicas (Indiviual Taxpayer Registry) number. Similar to a Social Security number in the US. * `CNPJ` - Cadastro Nacional de Pessoa Juridica (National Registry of Legal Entities) number. Unique ID for legal entities, such as companies and organizations, in Brazil * `EMAIL` - Email * `PHONE` - Phone number * `EVP` - Endereco de pagamento virtual (virtual payment address). A randomly-generated UUID number. - `reason` 'USER_REQUESTED' | 'BRANCH_TRANSFER' | 'RECONCILIATION' | 'RFB_VALIDATION', required — Reason for request * `USER_REQUESTED` - EVP keys are not supported - `bank_account` PresenterUpdateBankAccount, required - `opening_datetime` string, date-time — Opening date time. A RFC 3339 date-time value. For example - `2023-04-12T23:20:50.52Z`. - `name_type` 'REGISTRATION_NAME' | 'SOCIAL_NAME' — Name type: * `REGISTRATION_NAME` - Name assigned at birth * `SOCIAL_NAME` - Preferred name, not necessarily `REGISTRATION_NAME` (not supported when key owner is a `LEGAL_PERSON`) ## Response `200` OK - PresenterUpdateResponse - `bank_account` PresenterBankAccount, required - `participant` string, required — Participant's ISPB (Identifcador do Sistema de Pagamento Brazil) number - the Brazilian Payment System identifier, an 8-digit value. - `account_number` string, required — Account number. - `account_type` 'CACC' | 'SLRY' | 'SVGS' | 'TRAN', required — Account type:
`CACC` - Checking/current account. Known as "conta corrente" in Portuguese, this is a bank account type designed for everyday financial transactions and is the most common type individuals and businesses use for day-to-day banking.
`SVGS` - Savings account
`TRAN` - Payment account. Payment institutions offer payment accounts to move funds and make payments, while banks offer checking accounts that include full financial services such as credit and investments.
`SLRY` - Salary account. Employer deposits a fixed amount every month.
- `branch` string, required — This could be a bank-assigned branch ID or the branch's ISPB number. - `opening_datetime` string, date-time, required — Opening date time. A RFC 3339 date-time value. For example - `2023-04-12T23:20:50.52Z`. - `creation_datetime` string, date-time, required — Creation datetime. A RFC 3339 date-time value. For example - `2023-04-12T23:20:50.52Z`. - `key` string, required — Pix key value. - `key_type` 'CPF' | 'CNPJ' | 'PHONE' | 'EMAIL' | 'EVP', required — User information that can be used to create a Pix key: * `CPF` - Cadastro de Pessoas Fisicas (Indiviual Taxpayer Registry) number. Similar to a Social Security number in the US. * `CNPJ` - Cadastro Nacional de Pessoa Juridica (National Registry of Legal Entities) number. Unique ID for legal entities, such as companies and organizations, in Brazil * `EMAIL` - Email * `PHONE` - Phone number * `EVP` - Endereco de pagamento virtual (virtual payment address). A randomly-generated UUID number. - `owner` PresenterOwner, required - `document_number` string, required — Cardholder government document number. This can be from any document that identifies the cardholder such as a Tax ID, State ID, or driver's license. - `name` string, required — Person's name - `type` 'LEGAL_PERSON' | 'NATURAL_PERSON', required — Person type: * `LEGAL_PERSON` - An actual person with legal rights. * `NATURAL_PERSON` - An entity, such as an organization or company. - `trade_name` string — Name under which the business operates. Not necessarily the same as the legal name. - `reason` string, required — Reason that indicates why the card was added to the Protection Bulletin. - `open_claim_creation_datetime` string, date-time — Open claim creation date time. A RFC 3339 date-time value. For example - `2023-04-12T23:20:50.52Z`. - `ownership_datetime` string, date-time — Ownership date time. A RFC 3339 date-time value. For example - `2023-04-12T23:20:50.52Z`. - `account_id` integer — Account ID - `content_id` string — Content ID. This is a hashed value created from a number of key-related fields in the Pismo database. This is meant for you to store and send to Pismo in case there is any problem with the key. - `correlation_id` string — The Correlation identifier field is used to link related API requests and events. The CID can help the Pismo engineering team track everything related to a call. If not passed, a random one is generated. You can find the CID in the response header. - `status` 'ACTIVE' | 'DELETED' | 'PROCESSING' — Key status: * `ACTIVE` - Key is active * `DELETED` - Key was removed * `PROCESSING` - An error occurred during the request to the PSP. The process continues asynchronously in this case. ## Other responses - `202` — Accepted - `400` — Bad Request - `401` — Access token is missing or invalid - `403` — The request has been lost - `404` — Resource Not Found - `409` — Conflict - `429` — Too many reqquests - `500` — Internal Server Error - `502` — Bad Gateway - `503` — Service Unavailable - `504` — Gateway timeout --- [API](https://skmtc.net/pismo/apis/platform-authentication.md) · [All operations](https://skmtc.net/pismo/apis/platform-authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pismo/platform-authentication/versions/935b62e16de4/schema)