---
title: "Informar permissão de acesso à agenda por meio de opt-in (CERC-AP004)"
method: POST
path: "/opt_in"
tags: ["Opt-in/out"]
---

# Informar permissão de acesso à agenda por meio de opt-in (CERC-AP004)

`POST /opt_in`

## Request body

- object[]
  - `tipoOperacao` 'C' | 'A', required — Identifica o tipo de operação correspondente àquela entrada, sendo:: - C = Criar; - A = Atualizar;
  - `referenciaExterna` string, required — Código de referência único (exclusivo), de controle do participante, para identificação nas próximas consultas relacionadas. [Não atualizável]
  - `cnpjSolicitante` string, required — CNPJ do solicitante. 14 dígitos alfanuméricos para CNPJ e 11 dígitos para CPF e completar com 0 à esquerda, se necessário. [Não atualizável]
  - `cnpjFinanciador` string, required — CNPJ do financiador ou não financeira autorizado. 14 dígitos alfanuméricos para CNPJ e 11 dígitos para CPF e completar com 0 à esquerda, se necessário.
  - `dataAssinaturaOptIn` string, date, required — Data em que foi concedida a autorização pelo Usuário Final Recebedor, no formato AAAA-MM-DD.
  - `definicaoUnidadeRecebivel` DefinicaoUnidadeRecebivelTitular, required — Objeto com a definição de unidade recebível
    - `listaCnpjCredenciadora` string[], required — CNPJ da instituição credenciadora ou subcredenciadora responsável pela agenda. Sem formatação. Preenchidos com 0 à esquerda. - 99T = Usar esta opção para indicar todos as credenciadoras/sub.
    - `documentoUsuarioFinalRecebedor` string — CPF ou CNPJ (completo ou raiz) do Usuario final recebedor da UR. Sem formatação. Preenchidos com 0 à esquerda.
    - `documentoTitular` string — CPF ou CNPJ (completo ou raiz) do Titular da UR. Sem formatação. Preenchidos com 0 à esquerda.
    - `listaCodigoArranjoPagamento` string[], required — Código constante da tabela vigente neste manual. - 99T = Usar esta opção para indicar todos os arranjos.
    - `dataInicio` string, date, required — Data Inicio
    - `dataFim` string, date, required — Data Fim
  - `carteira` string — Código da carteira à qual o contrato pertence. Caso o campo não seja informado será utilizada a carteira padrão do participante. Obrigatório e atualizável caso a empresa seja do tipo "Prestador de Serviço".
  - `protocolo` string — Protocolo de retorno recebido na criação do opt-in.

## Response `207`

Dados do sucesso da operação

- object[]
  - `protocolo` string — GUID ID de Protocolo gerado pela CERC, confirmando o recebimento da requisição
  - `referenciaExterna` string — Código de referência de controle do participante, para identificação nas próximas consultas relacionadas
  - `dataHoraProcessamento` string, date-time — Data/hora da requisição
  - `status` '0' | '1' — Tipo de conta onde o pagamento será liquidado: - 0 = Pedido processado com sucesso. - 1 = Pedido processado com erro.
  - `erros` Erro[]
    - `codigo` string — Código do erro - Consultar Tabela de Erro
    - `mensagem` string — Descrição do erro - Consultar Tabela de Erro

## Other responses

- `400` — Tabela de Erros |CÓDIGO|DESCRIÇÃO |------|-----------------------------------------------------------------------------| |104001|TIPO DE OPERACAO OBRIGATORIO | |104002|TIPO DE OPERACAO INVALIDO | |104003|REFERENCIA EXTERNA OBRIGATORIA | |104004|REFERENCIA EXTERNA JA EXISTE | |104005|REFERENCIA EXTERNA INVALIDA | |104006|SOLICITANTE OBRIGATORIO | |104007|CNPJ DO SOLICITANTE OBRIGATORIO | |104008|CNPJ DO FINANCIADOR OU NAO FINANCEIRA INVALIDO | |104009|FINANCIADOR OU NAO FINANCEIRA NAO ENCONTRADO | |104010|INSTITUICAO CREDENCIADORA OU SUBCREDENCIADORA OBRIGATORIA | |104011|CPF OU CNPJ DA INSTITUICAO CREDENCIADORA OU SUBCREDENCIADORA INVALIDA | |104012|INSTITUICAO CREDENCIADORA OU SUBCREDENCIADORA NAO ENCONTRADA NA BASE DE CONTROLE| |104013|USUARIO FINAL RECEBEDOR OBRIGATORIO | |104014|CPF OU CNPJ DO USUARIO FINAL RECEBEDOR OBRIGATORIO | |104015|ARRANJO DE PAGAMENTO OBRIGATORIO | |104016|ARRANJO DE PAGAMENTO INVALIDO | |104017|DATA DE ASSINATURA DO OPT IN OBRIGATORIA | |104018|DATA DE ASSINATURA DO OPT IN INVALIDA | |104019|DATA DE INICIO OBRIGATORIA | |104020|DATA DE INICIO INVALIDA | |104021|DATA DE FIM OBRIGATORIA | |104022|DATA DE FIM DEVE SER MAIOR OU IGUAL A DATA DE INICIO | |104023|DATA DE FIM INVALIDA | |104024|CPF OU CNPJ DO TITULAR INVALIDO | |104025|PROTOCOLO OBRIGATORIO PARA TIPO DE OPERACAO | |104026|PROTOCOLO NAO ENCONTRADO | |104027|CARTEIRA INVALIDA | |104028|CARTEIRA NAO ENCONTRATA | |104801|OPERACAO NAO PERMITIDA - ACESSO NEGADO | |104802|OPERACAO INVALIDA PARA O REGISTRO ATUAL | |104803|OPT-IN JA INFORMADO | |104804|ERRO DEVIDO A ATUALIZACAO DE CAMPOS NAO PERMITIDOS | |104804|USUARIO FINAL RECEBEDOR NAO ENCONTRADO | |104805|TITULAR NAO ENCONTRADO | |104806|DATA DE INICIO MENOR QUE DATA DE ASSINATURA DO OPT-IN | |104807|FALHA NO REGISTRO NO AMBIENTE DE INTEROPERABILIDADE | |104808|ERRO GENERICO DE VALIDACAO | |104901|LAYOUT INVALIDO | |104902|ARQUIVO ENVIADO FORA DA GRADE HORARIA | |104903|NOME DO ARQUIVO JA ENVIADO | |104904|NOME DO ARQUIVO INVALIDO | |104999|ERRO INESPERADO |

---

[API](https://skmtc.net/cerc/apis/receb-veis-de-arranjo-de-pagamento-institui-es-financeiras-d.md) · [All operations](https://skmtc.net/cerc/apis/receb-veis-de-arranjo-de-pagamento-institui-es-financeiras-d/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cerc/receb-veis-de-arranjo-de-pagamento-institui-es-financeiras-d/revisions/98997c37ec38/schema)