Obtenção do documento (acordo legal)
beta
Este endpoint permite ao parceiro Bankly obter o documento do acordo legal para ser visualizado e aceito pelo seu cliente.
Atualmente, este endpoint apenas retorna o documento de termos e condições de uso da conta. Após obtê-lo, o parceiro será responsável por expor o termo na experiência do usuário.
Nota
Não é necessário realizar o download do termo de uso para cada cliente. Para reutilização, recomendamos salvá-lo em cache.
Importante
Recordamos que o documento de termos e condições de uso deve ser aplicado para cada conta individualmente.
Pré-requisitos
Para que seja possível utilizar este endpoint:
- Em ambiente de sandbox, é necessário que o produto esteja contratado e que o acesso às APIs esteja configurado para este ambiente;
- Em ambiente de produção, é necessário que o onboarding do produto já tenha sido homologado pela equipe de TAM.
Requisição (Request)
Requisição HTTP
GET https://api-mtls.sandbox.bankly.com.br/legal-agreements/file?type=TERMS_AND_CONDITIONS_OF_USE
--request GET \
--url https://api-mtls.sandbox.bankly.com.br/legal-agreements/file?type=TERMS_AND_CONDITIONS_OF_USE \
--header 'Authorization: Bearer {Token}' \
--header 'api-version: 1.0'
Autorização
Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:
| Scope | Descrição |
|---|---|
legal.agreements.read | Concede acesso para obter o arquivo do acordo legal. |
Cabeçalhos (Headers)
| Nome | Descrição |
|---|---|
api-version | Versão da API. Atualmente estamos na versão 1.0. |
Authorization | Obrigatório. Token de autorização do tipo Bearer. |
Parâmetros da rota (Path)
No path desta requisição envie o seguinte campo:
| Nome | Tipo | Descrição | Especificação |
|---|---|---|---|
type | query | Tipo de acordo a ser obtido. Importante: este campo não é obrigatório, porém se for enviado, informe o valor “TERMS_AND_CONDITIONS_OF_USE” (termos e condições de uso). | — |
Nota
Caso o campo
typenão seja enviado, será considerado o valor padrão "TERMS_AND_CONDITIONS_OF_USE".
Corpo da requisição (Body)
Não é necessário enviar campos no body desta requisição.
Resposta (Response)
O status code 200 indicará que a solicitação foi aceita com sucesso.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:
| Nome | Tipo | Descrição | Número máximo de caracteres |
|---|---|---|---|
type | string | Tipo do acordo, que neste caso é "TERMS_AND_CONDITIONS_OF_USE" (termos e condições de uso). | — |
contentType | string | Tipo de retorno da requisição. | — |
file | string | Arquivo do acordo em base64. | — |
{
"type": "TERMS_AND_CONDITIONS_OF_USE",
"contentType": "application/pdf",
"file": "JVBERi0xLjcNCiW1tbW1DQoxIDAgb2JqDQo8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFIvTGFuZyh..."
}
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.
Erros
Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.
Eventos
Este endpoint não possui eventos relacionados a ele.
Updated 23 days ago