Atualização de Documentação Cadastral do Cedente em Base64

Sempre que um cedente atualiza seu cadastro na plataforma nós enviamos este evento com a respectiva documentação compactada e codificada em Base64, além disso, enviamos também o CNPJ do cedente e o checksum hash para atestar a validade dos arquivos.

Sua API deve respeitar o princípio de idempotência, pois em casos raros o webhook poderá ser entregue mais de uma vez.

Timeout e idempotência

Ao enviar um webhook, aguardamos até 10 segundos para estabelecer a conexão e 60 segundos pela resposta da sua API. Caso esse prazo seja excedido ou a resposta tenha um status HTTP diferente de 2xx, a entrega será considerada uma falha.

Como um mesmo evento pode ser entregue mais de uma vez, sua API deve garantir a idempotência do processamento. Recomendamos responder com 2xx o mais rápido possível, processar operações demoradas de forma assíncrona e utilizar o identificador único do evento para evitar duplicidades.

Sobre este webhook

EventType: SellerDocumentUpdatedEvent

Path: /seller-documents

Webhook payload object

ChaveTipoDescrição

buyerId


integer

Identificador do investidor.

sellerId


integer

Identificador do cedente.

sellerGovernmentId


string

CNPJ ou CPF do cedente.

data64


binary

Conteúdo da documentação em Base64.

checksumHash


string

Hash que garante a validade do conteúdo do arquivo.

eventType


string

Nome do evento.

_links


object

Recursos disponíveis através de HATEOAS.
Para saber mais clique aqui.

Recursos disponíveis são:
approve - Aprovar cedente.
unapprove - Reprovar cedente.
documents - Download da documentação do cedente.
update - Alterar grupo de risco do cedente.
self - Listar dados do cedente.
sellers - Listar todos os cedentes.

Webhook payload example

{
   "buyerId":78676,
   "sellerId":1639274,
   "sellerGovernmentId":"22874589000179",
   "data64":"UEsDBBQACAgIAPoBdE4AAAAAAAAAAAAAAAAdAAAATGF5b3V0IDAyIC0gQ2FkY ...",
   "checksumHash":"8a24db9bcae7d29aae3d26ade088463ab96b0e71c3374cf550065503638f1b1a",
   "eventType":"SellerDocumentCreatedEvent",
   "_links":{
      "approve":{
         "href":"https://zuul.monkey.exchange/v1/buyers/78676/sellers/1639274/approve",
         "type":"POST"
      },
      "unapprove":{
         "href":"https://zuul.monkey.exchange/v1/buyers/78676/sellers/1639274/unapprove",
         "type":"POST"
      },
      "documents":{
         "href":"https://zuul.monkey.exchange/v1/buyers/78676/sellers/1639274/documents",
         "type":"GET"
      },
      "update":{
         "href":"https://zuul.monkey.exchange/v1/buyers/78676/sellers/1639274",
         "type":"PUT"
      },
      "self":{
         "href":"https://zuul.monkey.exchange/v1/buyers/78676/sellers/1639274",
         "type":"GET"
      },
      "sellers":{
         "href":"https://dev-zuul.monkeyecx.com/v1/buyers/78676/sellers",
         "type":"GET"
      }
   }
}

Did this page help you?