Referência da API

Referência da API

A referência abaixo foi gerada a partir do backend Api-Core em produção. Cada operação possui descrição de uso, parâmetros, exemplo de chamada em Shell, Node, Deno, Python, C# e Rust, além de um painel de teste interativo.

221operações REST

v1versão da API

19grupos funcionais

Try item todas as páginas

Autenticação

GET Consultar usuário atual /api/auth/v1/current-user POST Criar ou executar facebook autenticação /api/auth/v1/facebook-auth POST Criar ou executar google autenticação /api/auth/v1/google-auth POST Criar ou executar linkedin autenticação /api/auth/v1/linkedin-auth POST Realizar login /api/auth/v1/login POST Encerrar sessão /api/auth/v1/logout POST Criar ou executar microsoft autenticação /api/auth/v1/microsoft-auth POST Gerar token de acesso /api/auth/v1/token POST Renovar token de acesso /api/auth/v1/token/refresh

Cadastro

POST Criar ou executar financiador ou sacado quiz /api/registration/v1/buyer_quiz POST Criar ou executar cnpj lookup /api/registration/v1/cnpj-lookup POST Criar ou executar confirm migration conta /api/registration/v1/confirm-migration-account/{uidb64}/{token} POST Criar ou executar create conta /api/registration/v1/create-account POST Criar ou executar create empresa /api/registration/v1/create-company POST Criar ou executar cedente quiz /api/registration/v1/seller_quiz POST Criar ou executar send verification email /api/registration/v1/send-verification-email POST Criar ou executar verify token /api/registration/v1/verify-token/{uidb64}/{token} GET Consultar empresas /api/registration/v2/companies/{identifier} PATCH Atualizar empresas /api/registration/v2/companies/{identifier} POST Gerenciar documentos /api/registration/v2/companies/{identifier}/documents POST Criar ou executar submit /api/registration/v2/companies/{identifier}/submit

Conta escrow

GET Listar contas escrow /api/escrow-account/v1/{company_role_id} GET Listar contas escrow /api/escrow-account/v1/{company_role_id}/accounts/{account_id}/bank-slips GET Listar contas escrow /api/escrow-account/v1/{company_role_id}/accounts/{account_id}/bank-slips/{bank_slip_id}/download GET Consultar extrato de conta escrow /api/escrow-account/v1/{company_role_id}/accounts/{account_id}/extract GET Listar lançamentos da conta escrow /api/escrow-account/v1/{company_role_id}/accounts/{account_id}/statements GET Listar contas escrow /api/escrow-account/v1/{company_role_id}/bank-slips/enabled

Contas bancárias

GET Listar bancos /api/company/v1/list-banks GET Gerenciar contas bancárias /api/company/v1/{company_role_id}/bank-account POST Gerenciar contas bancárias /api/company/v1/{company_role_id}/bank-account GET Consultar bancária conta /api/company/v1/{company_role_id}/bank-account/{bank_account_id} DELETE Remover bancária conta /api/company/v1/{company_role_id}/bank-account/{bank_account_id}

Cotações

GET Listar compradores conhecidos /api/v1/quotation/{company_role_id}/buyers GET Listar cotações /api/v1/quotation/{company_role_id}/list POST Criar cotação /api/v1/quotation/{company_role_id}/new GET Consultar nota fiscal /api/v1/quotation/{invoice_id}/invoice POST Criar ou executar nota fiscal /api/v1/quotation/{invoice_id}/invoice PATCH Atualizar nota fiscal /api/v1/quotation/{invoice_id}/invoice GET Consultar cotação /api/v1/quotation/{quotation_id} PATCH Atualizar cotação /api/v1/quotation/{quotation_id} DELETE Remover cotação /api/v1/quotation/{quotation_id} PUT Adicionar nota à cotação /api/v1/quotation/{quotation_id}/add-invoice DELETE Remover nota da cotação /api/v1/quotation/{quotation_id}/delete-invoice PATCH Configurar documentação da cotação /api/v1/quotation/{quotation_id}/documentation GET Gerenciar documentos /api/v1/quotation/{quotation_id}/documents GET Consultar resumo da cotação /api/v1/quotation/{quotation_id}/general-data POST Importar XML da cotação /api/v1/quotation/{quotation_id}/import POST Importar PDF da cotação /api/v1/quotation/{quotation_id}/import-pdf POST Confirmar extração de PDF da cotação /api/v1/quotation/{quotation_id}/import-pdf/confirm POST Avaliar extração de PDF da cotação /api/v1/quotation/{quotation_id}/import-pdf/evaluate GET Importar PDF da cotação /api/v1/quotation/{quotation_id}/import-pdf/stream PATCH Atualizar pagamentos /api/v1/quotation/{quotation_id}/payments PATCH Atualizar pagamentos by emission /api/v1/quotation/{quotation_id}/payments-by-emission POST Criar ou executar pendências /api/v1/quotation/{quotation_id}/requirements POST Criar ou executar send to analysis /api/v1/quotation/{quotation_id}/send-to-analysis POST Gerenciar contas bancárias /api/v1/quotation/{quotation_id}/set-bank-account

Documentos

GET Gerenciar documentos /api/company/v1/{company_role_id}/documents POST Gerenciar documentos /api/company/v1/{company_role_id}/documents GET Verificar documentos pendentes /api/company/v1/{company_role_id}/documents/check POST Confirmar upload de documento /api/company/v1/{company_role_id}/documents/confirm-upload POST Baixar documentos /api/company/v1/{company_role_id}/documents/download GET Baixar documentos em ZIP /api/company/v1/{company_role_id}/documents/zip DELETE Remover documentos /api/company/v1/{company_role_id}/documents/{id}

Empresa

GET Listar empresas do usuário /api/company/v1/get-user-companies POST Criar ou executar confirm uploads /api/company/v1/virtual-visit/{schedule_id}/confirm-uploads GET Consultar info /api/company/v1/virtual-visit/{schedule_id}/info POST Criar ou executar pre visita /api/company/v1/virtual-visit/{schedule_id}/pre-visit GET Consultar empresa /api/company/v1/{company_role_id} GET Consultar analysis score /api/company/v1/{company_role_id}/analysis-score/{seller_id} POST Criar ou executar bancária conta /api/company/v1/{company_role_id}/bank-account/{bank_account_id} GET Consultar check documentos /api/company/v1/{company_role_id}/buyer/check-documents/{seller_id} GET Consultar documentos /api/company/v1/{company_role_id}/buyer/documents/{seller_id} POST Criar ou executar download documentos /api/company/v1/{company_role_id}/buyer/download-documents/{seller_id} GET Consultar zip documentos /api/company/v1/{company_role_id}/buyer/zip-documents/{seller_id} GET Consultar financiador ou sacado setting /api/company/v1/{company_role_id}/buyer_setting POST Criar ou executar financiador ou sacado setting /api/company/v1/{company_role_id}/buyer_setting POST Criar ou executar find or create /api/company/v1/{company_role_id}/chat/conversations/find-or-create POST Criar ou executar confirm /api/company/v1/{company_role_id}/chat/conversations/{conversation_id}/attachments/{attachment_id}/confirm GET Consultar download url /api/company/v1/{company_role_id}/chat/conversations/{conversation_id}/attachments/{attachment_id}/download-url POST Criar ou executar upload url /api/company/v1/{company_role_id}/chat/conversations/{conversation_id}/audio/upload-url POST Criar ou executar discard /api/company/v1/{company_role_id}/chat/conversations/{conversation_id}/documents/discard POST Criar ou executar upload urls /api/company/v1/{company_role_id}/chat/conversations/{conversation_id}/documents/upload-urls GET Consultar messages /api/company/v1/{company_role_id}/chat/conversations/{conversation_id}/messages POST Criar ou executar messages /api/company/v1/{company_role_id}/chat/conversations/{conversation_id}/messages PATCH Atualizar messages /api/company/v1/{company_role_id}/chat/conversations/{conversation_id}/messages/{message_id} DELETE Remover messages /api/company/v1/{company_role_id}/chat/conversations/{conversation_id}/messages/{message_id} POST Criar ou executar reactions /api/company/v1/{company_role_id}/chat/conversations/{conversation_id}/messages/{message_id}/reactions GET Consultar quick replies /api/company/v1/{company_role_id}/chat/conversations/{conversation_id}/quick-replies POST Criar ou executar read /api/company/v1/{company_role_id}/chat/conversations/{conversation_id}/read GET Consultar título mentions /api/company/v1/{company_role_id}/chat/conversations/{conversation_id}/title-mentions GET Consultar presence /api/company/v1/{company_role_id}/chat/partners/{partner_company_role_id}/presence GET Consultar presence /api/company/v1/{company_role_id}/chat/presence PUT Substituir presence /api/company/v1/{company_role_id}/chat/presence DELETE Remover presence /api/company/v1/{company_role_id}/chat/presence GET Consultar search /api/company/v1/{company_role_id}/chat/search GET Consultar state /api/company/v1/{company_role_id}/chat/state GET Consultar check access /api/company/v1/{company_role_id}/check-access GET Consultar clientes /api/company/v1/{company_role_id}/customers POST Criar ou executar clientes /api/company/v1/{company_role_id}/customers GET Consultar whitelist /api/company/v1/{company_role_id}/customers/coverage/whitelist GET Consultar clientes /api/company/v1/{company_role_id}/customers/{id} POST Criar ou executar clientes /api/company/v1/{company_role_id}/customers/{id} DELETE Remover clientes /api/company/v1/{company_role_id}/customers/{id} GET Consultar diferenças da extração documental /api/company/v1/{company_role_id}/document-extraction/{extraction_id}/diff POST Validar extração documental /api/company/v1/{company_role_id}/document-extraction/{extraction_id}/validate GET Consultar validations /api/company/v1/{company_role_id}/document-extraction/{extraction_id}/validations POST Criar ou executar ai analysis /api/company/v1/{company_role_id}/documents/ai-analysis POST Criar ou executar ai upload /api/company/v1/{company_role_id}/documents/ai-upload POST Confirmar extração de documento /api/company/v1/{company_role_id}/documents/confirm PATCH Atualizar edit empresa /api/company/v1/{company_role_id}/edit-company GET Consultar forms /api/company/v1/{company_role_id}/forms/{seller_id} GET Consultar public data /api/company/v1/{company_role_id}/public-data/{seller_id} POST Criar ou executar ratings /api/company/v1/{company_role_id}/ratings GET Consultar ratings /api/company/v1/{company_role_id}/ratings/{seller_id} POST Criar ou executar ratings /api/company/v1/{company_role_id}/ratings/{seller_id} DELETE Remover ratings /api/company/v1/{company_role_id}/ratings/{seller_id} POST Criar ou executar reactivate /api/company/v1/{company_role_id}/reactivate GET Consultar representatives /api/company/v1/{company_role_id}/representatives/{seller_id}/{partner_id} PATCH Atualizar dismiss /api/company/v1/{company_role_id}/requirements/{requirement_code}/dismiss GET Consultar revenue /api/company/v1/{company_role_id}/revenue/{seller_id} POST Criar ou executar cedente quiz /api/company/v1/{company_role_id}/seller-quiz GET Consultar cedente quiz status /api/company/v1/{company_role_id}/seller-quiz-status POST Criar ou executar send to analysis /api/company/v1/{company_role_id}/send-to-analysis GET Consultar serasa /api/company/v1/{company_role_id}/serasa/{seller_id} GET Gerenciar documentos /api/company/v1/{company_role_id}/signature-documents GET Consultar assinatura documentos /api/company/v1/{company_role_id}/signature-documents/{document_id} GET Consultar download link /api/company/v1/{company_role_id}/signature-documents/{document_id}/download-link GET Consultar signing link /api/company/v1/{company_role_id}/signature-documents/{document_id}/signers/{signer_id}/signing-link POST Criar ou executar touch access /api/company/v1/{company_role_id}/touch-access GET Consultar available dates /api/company/v1/{company_role_id}/virtual-visit/available-dates GET Consultar available slots /api/company/v1/{company_role_id}/virtual-visit/available-slots GET Consultar schedule /api/company/v1/{company_role_id}/virtual-visit/schedule POST Criar ou executar schedule /api/company/v1/{company_role_id}/virtual-visit/schedule POST Criar ou executar cancel /api/company/v1/{company_role_id}/virtual-visit/schedule/{schedule_id}/cancel POST Criar ou executar reschedule /api/company/v1/{company_role_id}/virtual-visit/schedule/{schedule_id}/reschedule POST Criar ou executar ai analysis /api/company/v2/{company_role_id}/documents/ai-analysis POST Criar ou executar ai upload /api/company/v2/{company_role_id}/documents/ai-upload POST Criar ou executar ai upload and process /api/company/v2/{company_role_id}/documents/ai-upload-and-process GET Consultar documento solicitation /api/company/{version}/{company_role_id}/document-solicitation/{seller_id} POST Criar ou executar documento solicitation /api/company/{version}/{company_role_id}/document-solicitation/{seller_id} PATCH Atualizar documento solicitation /api/company/{version}/{company_role_id}/document-solicitation/{seller_id}/{solicitation_id}

Feature flags

GET Consultar feature flags /api/v1/feature-flags/{name}

Geral

POST Gerar token de acesso /api/v1/auth/api-token POST Criar ou executar chat conversations /api/v1/chat-conversations POST Gerenciar documentos /api/v1/chat-documents GET Consultar chat título mentions /api/v1/chat-title-mentions GET Consultar cities /api/v1/cities GET Consultar empresa role /api/v1/company-role/{role_id} GET Consultar documento /api/v1/document/{document_id} GET Consultar feature flags /api/v1/feature-flags GET Consultar api feature /api/v1/me/api-feature GET Consultar api tokens /api/v1/me/api-tokens POST Criar ou executar api tokens /api/v1/me/api-tokens POST Criar ou executar revoke /api/v1/me/api-tokens/{token_id}/revoke POST Criar ou executar messagebird /api/v1/messagebird GET Consultar usuário /api/v1/user/{user_id} POST Criar lance em título /api/v2/marketplace/{company_role_id}/title/{title_id}/bid GET Consultar comissão do título /api/v2/marketplace/{company_role_id}/title/{title_id}/commission POST Importar PDF da cotação /api/v2/quotation/{quotation_id}/import-pdf POST Criar ou executar d4sign /webhook/d4sign/{secret}/

Marketplace

GET Consultar última atualização do marketplace /api/v1/marketplace/last-update GET Listar produtos do marketplace /api/v1/marketplace/products POST Listar marketplace /api/v1/marketplace/{company_role_id} GET Consultar lance /api/v1/marketplace/{company_role_id}/bid/{bid_id} GET Consultar empresas /api/v1/marketplace/{company_role_id}/companies POST Listar meus lances /api/v1/marketplace/{company_role_id}/my-bids GET Consultar showcase config /api/v1/marketplace/{company_role_id}/showcase-config PATCH Atualizar showcase config /api/v1/marketplace/{company_role_id}/showcase-config GET Consultar título no marketplace /api/v1/marketplace/{company_role_id}/title/{title_id} POST Gerenciar contas bancárias /api/v1/marketplace/{company_role_id}/title/{title_id}/alter-bank-account POST Criar lance em título /api/v1/marketplace/{company_role_id}/title/{title_id}/bid POST Cancelar lance em título /api/v1/marketplace/{company_role_id}/title/{title_id}/cancel-bid POST Consultar título no marketplace /api/v1/marketplace/{company_role_id}/title/{title_id}/cancel-payment GET Consultar comissão do título /api/v1/marketplace/{company_role_id}/title/{title_id}/commission POST Confirmar pagamento de título /api/v1/marketplace/{company_role_id}/title/{title_id}/confirm-payment GET Gerenciar documentos /api/v1/marketplace/{company_role_id}/title/{title_id}/documents POST Gerenciar documentos /api/v1/marketplace/{company_role_id}/title/{title_id}/documents GET Consultar título no marketplace /api/v1/marketplace/{company_role_id}/title/{title_id}/invoices POST Consultar título no marketplace /api/v1/marketplace/{company_role_id}/title/{title_id}/partial-interest GET Gerenciar documentos /api/v1/marketplace/{company_role_id}/title/{title_id}/zip-documents GET Consultar last update /api/v1/marketplace/{title_id}/last-update

Notícias

GET Consultar news /api/v1/news/{company_role_id}

Notificações

GET Consultar notificações /api/company/v1/{company_role_id}/notifications PATCH Atualizar notificações /api/company/v1/{company_role_id}/notifications

Pendências

GET Consultar pendências /api/company/v1/{company_role_id}/requirements POST Criar ou executar pendencies /api/v1/pendencies/{company_role_id} GET Consultar pendências /api/v1/quotation/{quotation_id}/requirements

Prorrogações

PATCH Atualizar accept /api/v1/extensions/{extension_id}/accept GET Consultar get /api/v1/extensions/{extension_id}/get PATCH Atualizar proposal /api/v1/extensions/{extension_id}/proposal GET Consultar all /api/v1/extensions/{payment_id}/all POST Criar ou executar request /api/v1/extensions/{payment_id}/request

Relatórios

GET Consultar relatório de cliente /api/reports/v1/{company_role_id}/customer-summary GET Consultar relatório por vencimento /api/reports/v1/{company_role_id}/due-date-summary GET Consultar list empresas /api/reports/v1/{company_role_id}/list-companies GET Consultar relatório de maturidades /api/reports/v1/{company_role_id}/maturities GET Consultar relatório de cedente /api/reports/v1/{company_role_id}/seller-summary

Reputação

GET Consultar reputação /api/reputation/v1/{company_role_id} GET Consultar cedente /api/reputation/v1/{company_role_id}/seller/{seller_id} GET Consultar summary /api/reputation/v1/{company_role_id}/seller/{seller_id}/summary

Sócios

GET Consultar sócios /api/company/{version}/{company_role_id}/partners POST Criar ou executar sócios /api/company/{version}/{company_role_id}/partners GET Consultar all pf /api/company/{version}/{company_role_id}/partners/all-pf POST Criar ou executar quick /api/company/{version}/{company_role_id}/partners/quick GET Consultar sócios /api/company/{version}/{company_role_id}/partners/{partner_id} PATCH Atualizar sócios /api/company/{version}/{company_role_id}/partners/{partner_id} DELETE Remover sócios /api/company/{version}/{company_role_id}/partners/{partner_id}

Títulos

GET Consultar drawees /api/v1/titles/{company_role_id}/drawees POST Criar ou executar list /api/v1/titles/{company_role_id}/list GET Consultar títulos /api/v1/titles/{title_id} POST Criar ou executar lance /api/v1/titles/{title_id}/bid PATCH Atualizar change market type /api/v1/titles/{title_id}/change-market-type GET Gerenciar documentos /api/v1/titles/{title_id}/documents GET Consultar notas fiscais /api/v1/titles/{title_id}/invoices POST Gerenciar contas bancárias /api/v1/titles/{title_id}/set-bank-account PATCH Atualizar update rates /api/v1/titles/{title_id}/update-rates

Usuários da empresa

GET Consultar get usuários /api/company/v1/{company_role_id}/get-users POST Criar ou executar invite usuário /api/company/v1/{company_role_id}/invite-user GET Consultar usuário /api/company/v1/{company_role_id}/user/{user_permission_id} PATCH Atualizar usuário /api/company/v1/{company_role_id}/user/{user_permission_id} DELETE Remover usuário /api/company/v1/{company_role_id}/user/{user_permission_id}