> For the complete documentation index, see [llms.txt](https://www.notbank.com/learn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.notbank.com/learn/tutorial/pt-br/crypto-as-a-service-com-reliance.md).

# Crypto as a Service com reliance

A NotBank oferece um serviço de "Crypto as a Service" (CaaS) que fornece uma infraestrutura técnica robusta e documentada (API) para que terceiros (fintechs, bancos ou carteiras) possam integrar rapidamente funcionalidades completas de criptomoedas e ativos digitais sob sua própria marca. Essa solução permite às instituições oferecer aos seus clientes serviços como custódia segura, gestão de carteiras, conversão instantânea de fiat para cripto e operações de envio/recebimento, sem a necessidade de desenvolver do zero a complexidade da camada *blockchain*, o *backend*, a segurança ou a conformidade regulatória. Em essência, a NotBank gerencia a parte técnica, os riscos e a infraestrutura, atuando como ponte entre o mundo financeiro tradicional e o ecossistema cripto, o que permite a seus clientes concentrar-se exclusivamente na experiência do usuário e em sua estratégia comercial.

A Notbank oferece duas modalidades de seu serviço **Crypto as a Service (CaaS)** desenhadas para diferentes perfis de clientes e necessidades operacionais. O **CaaS padrão** fornece uma solução robusta de conformidade regulatória que acompanha cada cliente por meio de um processo de onboarding estruturado e abrangente. O **CaaS com reliance**, por outro lado, é voltado para aquelas instituições que já contam com um arcabouço de conformidade consolidado e uma reputação verificável, o que permite estabelecer um vínculo de confiança elevada entre as partes. Graças a esse nível adicional de confiança — sustentado em acordos de responsabilidade compartilhada e validação mútua — o processo de onboarding é agilizado consideravelmente, reduzindo prazos e fricções operacionais sem comprometer os padrões regulatórios exigidos.

Para poder começar a usar o Crypto as a Service (CaaS) com reliance, o interessado deve formalizar sua solicitação mediante a assinatura de um contrato de prestação de serviços. Esse contrato estabelece claramente os termos de uso, as responsabilidades e os acordos comerciais. Para iniciar esse processo, é necessário entrar em contato com nossa equipe de suporte clicando no [link](https://support.notbank.com/support/s/contactsupport?language=es) fornecido. Esse link o direcionará para um formulário de contato específico que deve ser preenchido. Assim que recebermos sua solicitação por meio do formulário, nossa equipe lhe enviará prontamente o contrato para sua revisão e posterior assinatura.

## 1. Autenticação na Notbank

A autenticação para acessar a API da Notbank é realizada de forma segura combinando as credenciais confidenciais da API com um identificador de usuário específico. Essas credenciais, obtidas na etapa anterior, funcionam como a prova de identidade da aplicação cliente. Ao incluir o identificador de usuário junto com essas credenciais na solicitação, a API pode verificar a identidade de quem faz a chamada e, crucialmente, autorizar as operações no nível da conta de usuário específica dentro do ecossistema da Notbank, garantindo que apenas os dados e as ações pertinentes estejam disponíveis.

{% tabs %}
{% tab title="cURL" %}

```bash
GET /ap/AuthenticateUser HTTP/1.1
Host: https://api.notbank.com
Content-Type: application/json
APIKey: "<public-key>",
Signature: "<signature>",
UserId: "<user-uuid>",
Nonce: "2247733562"

---

{
  "Authenticated": true,
  "SessionToken": "02de4e6d-43f2-4e89-7213-49a9935d5607",  // token, aptoken
  // ...
}
```

***

`Nonce` qualquer número arbitrário ou cadeia aleatória usada com a chave privada da API para gerar uma assinatura.

`Signature` é uma longa string alfanumérica gerada usando a chave privada da API e o nonce. Para gerar sua própria assinatura com um `nonce` diferente, você deve usar `HMAC-SHA256` para codificar seu `Nonce`, `UserId` (ID de usuário) e chave pública da API (`<public-key>`), no formato `NonceUserIdAPIPublicKey` usando a chave secreta da API (`<secret-key>`) como chave.
{% endtab %}

{% tab title="Node" %}

```js
import { NotbankClient } from 'notbank';

// criação de cliente REST HTTP
const restClient = NotbankClient.Factory.createRestClient();

// autenticação
await restClient.authenticateUser({
  ApiPublicKey: "public-key",
  ApiSecretKey: "secret-key",
  UserId: "user-uuid"
});
```

{% endtab %}
{% endtabs %}

## 2. Registrar um cliente na Notbank

Se você deseja **expandir seu próprio negócio** e oferecer serviços de criptomoedas aos seus usuários, nosso cadastro por meio da opção **Crypto as a Service (CaaS)** é o indicado. Essa poderosa integração permitirá incorporar e gerenciar seus próprios clientes dentro do ecossistema da Notbank, atuando como uma ponte entre seus usuários e todas as funcionalidades de nossa plataforma.

### 2.1 Registro de nível básico

{% tabs %}
{% tab title="cURL" %}

```bash
POST /api/nb/account/register HTTP/1.1
Host: https://api.notbank.com
Content-Type: application/json
aptoken: <token>

{ 
  "first_name": "Juan",
  "last_name": "Perez",
  "phone_number": "+56911111111",
  "profession": "trader",
  "gender": "1",
  "birthdate": "01/01/1990",
  "citizenship": "BR",
  "identity_type": "1",
  "identity_number": "55330450314",
  "identity_country": "BR",
  "address_country": "BR",
  "address_city": "São Paulo",
  "address_street": "Rua 1",
  "address_postal_code": "123456",
  // apenas Argentina (address_country=AR)
  "address_province": "1",
  "subject_comply": false,  // é sujeito obrigado
  // apenas Brasil (address_country=BR)
  "address_district": "Distrito 1",
  "address_number": "1234",
  "address_state": "SP",
  "address_complement": "Bloco 3" // opcional
  // apenas Chile (address_country=CL)
  "address_comune": "Arica",
  // apenas Peru (address_country=PE)
  "civil_status": "casado",
  "spouse_name": "María Soto",
  "pep": true,
  // apenas Peru e PEP (pep=true)  
  "pep_position": "Prefeito",
  "pep_institution": "Prefeitura de Santiago",
  "pep_links_description": "Rodrigo Pérez (Pai)",
  "is_pep_family_member": true,
  // apenas Peru e se o familiar for PEP (is_pep_family_member=true)
  "pep_family_member_name": "Luis Pérez",
  "pep_family_member_relation": "Avô"
}

---

{
  "status": "success",
  "data": {
    "userId": "<client-user-id>",
    "token": "<client-jwt>"
  }
}
```

{% endtab %}
{% endtabs %}

#### 2.1.1 Glossário

{% tabs %}
{% tab title="Profissão" %}

| Valor                      | Descrição                 |
| -------------------------- | ------------------------- |
| trader                     | Comerciante               |
| investor                   | Investidor                |
| student                    | Estudante                 |
| housewife                  | Dona de casa              |
| accountant                 | Contador                  |
| actor\_actress             | Ator/Atriz                |
| air\_hostess               | Comissária de bordo       |
| archaeologist              | Arqueólogo                |
| architect                  | Arquiteto                 |
| astronaut                  | Astronauta                |
| baker                      | Padeiro                   |
| biologist                  | Biólogo                   |
| bricklayer                 | Pedreiro                  |
| driver                     | Motorista                 |
| businessman                | Empresário                |
| butcher                    | Açougueiro                |
| caretaker\_janitor\_porter | Zelador/porteiro          |
| carpenter                  | Carpinteiro               |
| cashier                    | Caixa                     |
| cleaner                    | Faxineiro                 |
| clown                      | Palhaço                   |
| cobbler                    | Sapateiro                 |
| cook\_chef                 | Cozinheiro/Chef           |
| chemist                    | Químico                   |
| dancer                     | Dançarino                 |
| decorator                  | Decorador                 |
| dentist                    | Dentista                  |
| designer                   | Designer                  |
| physician                  | Médico                    |
| dressmaker                 | Costureira                |
| dustman                    | Coletor de lixo           |
| economist                  | Economista                |
| electrician                | Eletricista               |
| engineer                   | Engenheiro                |
| farmer                     | Agricultor                |
| fireman                    | Bombeiro                  |
| fisherman                  | Pescador                  |
| florist                    | Florista                  |
| fruiterer                  | Fruteiro                  |
| gardener                   | Jardineiro                |
| geologist                  | Geólogo                   |
| hairdresser                | Cabeleireiro              |
| jeweller                   | Joalheiro                 |
| journalist                 | Jornalista                |
| judge                      | Juiz                      |
| lawyer                     | Advogado                  |
| librarian                  | Bibliotecário             |
| life\_guard                | Salva-vidas               |
| mailman\_postman           | Carteiro                  |
| mechanic                   | Mecânico                  |
| meteorologist              | Meteorologista            |
| cryptocurrency\_miner      | Minerador de criptomoedas |
| mineral\_miner             | Minerador                 |
| model                      | Modelo                    |
| nanny\_nursemaid           | Babá                      |
| nun                        | Freira                    |
| nurse                      | Enfermeiro                |
| painter                    | Pintor                    |
| pastry\_cook               | Confeiteiro               |
| pharmacist                 | Farmacêutico              |
| photographer               | Fotógrafo                 |
| physicist                  | Físico                    |
| plumber                    | Encanador                 |
| policeman\_policewoman     | Policial                  |
| politician                 | Político                  |
| priest                     | Padre                     |
| professor\_teacher         | Professor                 |
| programmer                 | Programador               |
| psychiatrist               | Psiquiatra                |
| psychologist               | Psicólogo                 |
| receptionist               | Recepcionista             |
| researcher\_scientist      | Investigador científico   |
| sailor                     | Marinheiro                |
| salesman                   | Vendedor                  |
| secretary                  | Secretário                |
| shop\_assistant            | Atendente de loja         |
| singer                     | Cantor                    |
| social\_worker             | Assistente social         |
| sportsman                  | Esportista                |
| surgeon                    | Cirurgião                 |
| taxi\_driver               | Motorista de táxi         |
| telephone\_operator        | Operador telefônico       |
| travel\_agent              | Agente de viagens         |
| veterinarian               | Veterinário               |
| waiter\_waitress           | Garçom/Garçonete          |
| writer                     | Escritor                  |
| deliveryman                | Entregador                |
| uber\_driver               | Motorista de Uber         |
| pilot                      | Piloto                    |
| administrative             | Administrativo            |
| public\_servant            | Servidor público          |
| other                      | Outro                     |
| customer\_care             | Atendimento ao cliente    |
| military                   | Militar                   |
| manager\_officier          | Gerente/Oficial           |
| {% endtab %}               |                           |

{% tab title="Gênero" %}

| Valor        | Descrição |
| ------------ | --------- |
| 0            | Mulher    |
| 1            | Homem     |
| {% endtab %} |           |

{% tab title="Tipo de identidade" %}

| Valor        | Descrição                                   |
| ------------ | ------------------------------------------- |
| 1            | DNI                                         |
| 2            | Estrangeiro                                 |
| 3            | NUIP: Número único de identificação pessoal |
| 4            | NIP: Número de identificação pessoal        |
| 5            | PEP: Permissão especial de permanência      |
| 6            | CC: Cédula de cidadania                     |
| 7            | CE: Cédula de estrangeiro                   |
| 8            | Passaporte                                  |
| {% endtab %} |                                             |

{% tab title="Província (AR)" %}

| Valor        | Descrição                                         |
| ------------ | ------------------------------------------------- |
| 1            | Buenos Aires                                      |
| 10           | Catamarca                                         |
| 14           | Chaco                                             |
| 20           | Chubut                                            |
| 43           | Cidade Autônoma de Buenos Aires                   |
| 3            | Córdoba                                           |
| 15           | Corrientes                                        |
| 5            | Entre Ríos                                        |
| 13           | Formosa                                           |
| 11           | Jujuy                                             |
| 18           | La Pampa                                          |
| 9            | La Rioja                                          |
| 4            | Mendoza                                           |
| 16           | Misiones                                          |
| 19           | Neuquén                                           |
| 21           | Río Negro                                         |
| 12           | Salta                                             |
| 7            | San Juan                                          |
| 8            | San Luis                                          |
| 22           | Santa Cruz                                        |
| 2            | Santa Fe                                          |
| 6            | Santiago del Estero                               |
| 23           | Terra do Fogo, Antártida e Ilhas do Atlântico Sul |
| 17           | Tucumán                                           |
| {% endtab %} |                                                   |

{% tab title="Estado (BR)" %}

| Valor        | Descrição           |
| ------------ | ------------------- |
| RO           | Rondônia            |
| AC           | Acre                |
| AM           | Amazonas            |
| RR           | Roraima             |
| PA           | Pará                |
| AP           | Amapá               |
| TO           | Tocantins           |
| MA           | Maranhão            |
| PI           | Piauí               |
| CE           | Ceará               |
| RN           | Rio Grande do Norte |
| PB           | Paraíba             |
| PE           | Pernambuco          |
| AL           | Alagoas             |
| SE           | Sergipe             |
| BA           | Bahia               |
| MG           | Minas Gerais        |
| ES           | Espírito Santo      |
| RJ           | Rio de Janeiro      |
| SP           | São Paulo           |
| PR           | Paraná              |
| SC           | Santa Catarina      |
| RS           | Rio Grande do Sul   |
| MS           | Mato Grosso do Sul  |
| MT           | Mato Grosso         |
| GO           | Goiás               |
| DF           | Distrito Federal    |
| {% endtab %} |                     |

{% tab title="Comuna (CL)" %}

| Valor                        | Descrição                    |
| ---------------------------- | ---------------------------- |
| Arica                        | Arica                        |
| Camarones                    | Camarones                    |
| General Lagos                | General Lagos                |
| Putre                        | Putre                        |
| Alto Hospicio                | Alto Hospicio                |
| Camiña                       | Camiña                       |
| Colchane                     | Colchane                     |
| Huara                        | Huara                        |
| Iquique                      | Iquique                      |
| Pica                         | Pica                         |
| Pozo Almonte                 | Pozo Almonte                 |
| Antofagasta                  | Antofagasta                  |
| Calama                       | Calama                       |
| María Elena                  | María Elena                  |
| Mejillones                   | Mejillones                   |
| Ollagüe                      | Ollagüe                      |
| San Pedro de Atacama         | San Pedro de Atacama         |
| Sierra Gorda                 | Sierra Gorda                 |
| Taltal                       | Taltal                       |
| Tocopilla                    | Tocopilla                    |
| Alto del Carmen              | Alto del Carmen              |
| Caldera                      | Caldera                      |
| Chañaral                     | Chañaral                     |
| Copiapó                      | Copiapó                      |
| Diego de Almagro             | Diego de Almagro             |
| Freirina                     | Freirina                     |
| Huasco                       | Huasco                       |
| Tierra Amarilla              | Tierra Amarilla              |
| Vallenar                     | Vallenar                     |
| Andacollo                    | Andacollo                    |
| Canela                       | Canela                       |
| Combarbalá                   | Combarbalá                   |
| Coquimbo                     | Coquimbo                     |
| Illapel                      | Illapel                      |
| La Higuera                   | La Higuera                   |
| La Serena                    | La Serena                    |
| Los Vilos                    | Los Vilos                    |
| Monte Patria                 | Monte Patria                 |
| Ovalle                       | Ovalle                       |
| Paiguano                     | Paiguano                     |
| Punitaqui                    | Punitaqui                    |
| Río Hurtado                  | Río Hurtado                  |
| Salamanca                    | Salamanca                    |
| Vicuña                       | Vicuña                       |
| Algarrobo                    | Algarrobo                    |
| Cabildo                      | Cabildo                      |
| Calera                       | Calera                       |
| Calle Larga                  | Calle Larga                  |
| Cartagena                    | Cartagena                    |
| Casablanca                   | Casablanca                   |
| Catemu                       | Catemu                       |
| Concón                       | Concón                       |
| El Quisco                    | El Quisco                    |
| El Tabo                      | El Tabo                      |
| Hijuelas                     | Hijuelas                     |
| Ilha de Páscoa               | Ilha de Páscoa               |
| Juan Fernández               | Juan Fernández               |
| La Cruz                      | La Cruz                      |
| La Ligua                     | La Ligua                     |
| Limache                      | Limache                      |
| Llaillay                     | Llaillay                     |
| Los Andes                    | Los Andes                    |
| Nogales                      | Nogales                      |
| Olmué                        | Olmué                        |
| Panquehue                    | Panquehue                    |
| Papudo                       | Papudo                       |
| Petorca                      | Petorca                      |
| Puchuncaví                   | Puchuncaví                   |
| Putaendo                     | Putaendo                     |
| Quillota                     | Quillota                     |
| Quilpué                      | Quilpué                      |
| Quintero                     | Quintero                     |
| Rinconada                    | Rinconada                    |
| San Antonio                  | San Antonio                  |
| San Esteban                  | San Esteban                  |
| San Felipe                   | San Felipe                   |
| Santa María                  | Santa María                  |
| Santo Domingo                | Santo Domingo                |
| Valparaíso                   | Valparaíso                   |
| Villa Alemana                | Villa Alemana                |
| Viña del Mar                 | Viña del Mar                 |
| Zapallar                     | Zapallar                     |
| Alhué                        | Alhué                        |
| Buin                         | Buin                         |
| Calera de Tango              | Calera de Tango              |
| Cerrillos                    | Cerrillos                    |
| Cerro Navia                  | Cerro Navia                  |
| Colina                       | Colina                       |
| Conchalí                     | Conchalí                     |
| Curacaví                     | Curacaví                     |
| El Bosque                    | El Bosque                    |
| El Monte                     | El Monte                     |
| Estação Central              | Estação Central              |
| Huechuraba                   | Huechuraba                   |
| Independencia                | Independencia                |
| Isla de Maipo                | Isla de Maipo                |
| La Cisterna                  | La Cisterna                  |
| La Florida                   | La Florida                   |
| La Granja                    | La Granja                    |
| La Pintana                   | La Pintana                   |
| La Reina                     | La Reina                     |
| Lampa                        | Lampa                        |
| Las Condes                   | Las Condes                   |
| Lo Barnechea                 | Lo Barnechea                 |
| Lo Espejo                    | Lo Espejo                    |
| Lo Prado                     | Lo Prado                     |
| Macul                        | Macul                        |
| Maipú                        | Maipú                        |
| María Pinto                  | María Pinto                  |
| Melipilla                    | Melipilla                    |
| Ñuñoa                        | Ñuñoa                        |
| Padre Hurtado                | Padre Hurtado                |
| Paine                        | Paine                        |
| Pedro Aguirre Cerda          | Pedro Aguirre Cerda          |
| Peñaflor                     | Peñaflor                     |
| Peñalolén                    | Peñalolén                    |
| Pirque                       | Pirque                       |
| Providencia                  | Providencia                  |
| Pudahuel                     | Pudahuel                     |
| Puente Alto                  | Puente Alto                  |
| Quilicura                    | Quilicura                    |
| Quinta Normal                | Quinta Normal                |
| Recoleta                     | Recoleta                     |
| Renca                        | Renca                        |
| San Bernardo                 | San Bernardo                 |
| San Joaquín                  | San Joaquín                  |
| San José de Maipo            | San José de Maipo            |
| San Miguel                   | San Miguel                   |
| San Pedro                    | San Pedro                    |
| San Ramón                    | San Ramón                    |
| Santiago                     | Santiago                     |
| Talagante                    | Talagante                    |
| Tiltil                       | Tiltil                       |
| Vitacura                     | Vitacura                     |
| Chimbarongo                  | Chimbarongo                  |
| Chépica                      | Chépica                      |
| Codegua                      | Codegua                      |
| Coinco                       | Coinco                       |
| Coltauco                     | Coltauco                     |
| Doñihue                      | Doñihue                      |
| Graneros                     | Graneros                     |
| La Estrella                  | La Estrella                  |
| Las Cabras                   | Las Cabras                   |
| Litueche                     | Litueche                     |
| Lolol                        | Lolol                        |
| Machalí                      | Machalí                      |
| Malloa                       | Malloa                       |
| Marchihue                    | Marchihue                    |
| Nancagua                     | Nancagua                     |
| Navidad                      | Navidad                      |
| Olivar                       | Olivar                       |
| Palmilla                     | Palmilla                     |
| Paredones                    | Paredones                    |
| Peralillo                    | Peralillo                    |
| Peumo                        | Peumo                        |
| Pichidegua                   | Pichidegua                   |
| Pichilemu                    | Pichilemu                    |
| Placilla                     | Placilla                     |
| Pumanque                     | Pumanque                     |
| Quinta de Tilcoco            | Quinta de Tilcoco            |
| Rancagua                     | Rancagua                     |
| Rengo                        | Rengo                        |
| Requínoa                     | Requínoa                     |
| San Fernando                 | San Fernando                 |
| San Francisco de Mostazal    | San Francisco de Mostazal    |
| San Vicente de Tagua Tagua   | San Vicente de Tagua Tagua   |
| Santa Cruz                   | Santa Cruz                   |
| Cauquenes                    | Cauquenes                    |
| Chanco                       | Chanco                       |
| Colbún                       | Colbún                       |
| Constitución                 | Constitución                 |
| Curepto                      | Curepto                      |
| Curicó                       | Curicó                       |
| Empedrado                    | Empedrado                    |
| Hualañé                      | Hualañé                      |
| Licantén                     | Licantén                     |
| Linares                      | Linares                      |
| Longaví                      | Longaví                      |
| Maule                        | Maule                        |
| Molina                       | Molina                       |
| Parral                       | Parral                       |
| Pelarco                      | Pelarco                      |
| Pelluhue                     | Pelluhue                     |
| Pencahue                     | Pencahue                     |
| Rauco                        | Rauco                        |
| Retiro                       | Retiro                       |
| Romeral                      | Romeral                      |
| Río Claro                    | Río Claro                    |
| Sagrada Família              | Sagrada Família              |
| San Clemente                 | San Clemente                 |
| San Javier de Loncomilla     | San Javier de Loncomilla     |
| San Rafael                   | San Rafael                   |
| Talca                        | Talca                        |
| Teno                         | Teno                         |
| Vichuquén                    | Vichuquén                    |
| Villa Alegre                 | Villa Alegre                 |
| Yerbas Buenas                | Yerbas Buenas                |
| Bulnes                       | Bulnes                       |
| Chillán Viejo                | Chillán Viejo                |
| Chillán                      | Chillán                      |
| Cobquecura                   | Cobquecura                   |
| Coelemu                      | Coelemu                      |
| Coihueco                     | Coihueco                     |
| El Carmen                    | El Carmen                    |
| Ninhue                       | Ninhue                       |
| Ñiquén                       | Ñiquén                       |
| Pemuco                       | Pemuco                       |
| Pinto                        | Pinto                        |
| Portezuelo                   | Portezuelo                   |
| Quillón                      | Quillón                      |
| Quirihue                     | Quirihue                     |
| Ránquil                      | Ránquil                      |
| San Carlos                   | San Carlos                   |
| San Fabián                   | San Fabián                   |
| San Ignacio                  | San Ignacio                  |
| San Nicolás                  | San Nicolás                  |
| Treguaco                     | Treguaco                     |
| Yungay                       | Yungay                       |
| Alto Biobío                  | Alto Biobío                  |
| Antuco                       | Antuco                       |
| Arauco                       | Arauco                       |
| Cabrero                      | Cabrero                      |
| Cañete                       | Cañete                       |
| Chiguayante                  | Chiguayante                  |
| Concepción                   | Concepción                   |
| Contulmo                     | Contulmo                     |
| Coronel                      | Coronel                      |
| Curanilahue                  | Curanilahue                  |
| Florida                      | Florida                      |
| Hualpén                      | Hualpén                      |
| Hualqui                      | Hualqui                      |
| Laja                         | Laja                         |
| Lebu                         | Lebu                         |
| Los Álamos                   | Los Álamos                   |
| Los Ángeles                  | Los Ángeles                  |
| Lota                         | Lota                         |
| Mulchén                      | Mulchén                      |
| Nacimiento                   | Nacimiento                   |
| Negrete                      | Negrete                      |
| Penco                        | Penco                        |
| Quilaco                      | Quilaco                      |
| Quilleco                     | Quilleco                     |
| San Pedro de la Paz          | San Pedro de la Paz          |
| San Rosendo                  | San Rosendo                  |
| Santa Bárbara                | Santa Bárbara                |
| Santa Juana                  | Santa Juana                  |
| Talcahuano                   | Talcahuano                   |
| Tirúa                        | Tirúa                        |
| Tomé                         | Tomé                         |
| Tucapel                      | Tucapel                      |
| Yumbel                       | Yumbel                       |
| Angol                        | Angol                        |
| Carahue                      | Carahue                      |
| Cholchol                     | Cholchol                     |
| Collipulli                   | Collipulli                   |
| Cunco                        | Cunco                        |
| Curacautín                   | Curacautín                   |
| Curarrehue                   | Curarrehue                   |
| Ercilla                      | Ercilla                      |
| Freire                       | Freire                       |
| Galvarino                    | Galvarino                    |
| Gorbea                       | Gorbea                       |
| Lautaro                      | Lautaro                      |
| Loncoche                     | Loncoche                     |
| Lonquimay                    | Lonquimay                    |
| Los Sauces                   | Los Sauces                   |
| Lumaco                       | Lumaco                       |
| Melipeuco                    | Melipeuco                    |
| Nueva Imperial               | Nueva Imperial               |
| Padre las Casas              | Padre las Casas              |
| Perquenco                    | Perquenco                    |
| Pitrufquén                   | Pitrufquén                   |
| Pucón                        | Pucón                        |
| Purén                        | Purén                        |
| Renaico                      | Renaico                      |
| Saavedra                     | Saavedra                     |
| Temuco                       | Temuco                       |
| Teodoro Schmidt              | Teodoro Schmidt              |
| Toltén                       | Toltén                       |
| Traiguén                     | Traiguén                     |
| Victoria                     | Victoria                     |
| Vilcún                       | Vilcún                       |
| Villarrica                   | Villarrica                   |
| Corral                       | Corral                       |
| Futrono                      | Futrono                      |
| La Unión                     | La Unión                     |
| Lago Ranco                   | Lago Ranco                   |
| Lanco                        | Lanco                        |
| Los Lagos                    | Los Lagos                    |
| Mariquina                    | Mariquina                    |
| Máfil                        | Máfil                        |
| Paillaco                     | Paillaco                     |
| Panguipulli                  | Panguipulli                  |
| Río Bueno                    | Río Bueno                    |
| Valdivia                     | Valdivia                     |
| Ancud                        | Ancud                        |
| Calbuco                      | Calbuco                      |
| Castro                       | Castro                       |
| Chaitén                      | Chaitén                      |
| Chonchi                      | Chonchi                      |
| Cochamó                      | Cochamó                      |
| Curaco de Vélez              | Curaco de Vélez              |
| Dalcahue                     | Dalcahue                     |
| Fresia                       | Fresia                       |
| Frutillar                    | Frutillar                    |
| Futaleufú                    | Futaleufú                    |
| Hualaihué                    | Hualaihué                    |
| Llanquihue                   | Llanquihue                   |
| Los Muermos                  | Los Muermos                  |
| Maullín                      | Maullín                      |
| Osorno                       | Osorno                       |
| Palena                       | Palena                       |
| Puerto Montt                 | Puerto Montt                 |
| Puerto Octay                 | Puerto Octay                 |
| Puerto Varas                 | Puerto Varas                 |
| Puqueldón                    | Puqueldón                    |
| Purranque                    | Purranque                    |
| Puyehue                      | Puyehue                      |
| Queilén                      | Queilén                      |
| Quellón                      | Quellón                      |
| Quemchi                      | Quemchi                      |
| Quinchao                     | Quinchao                     |
| Río Negro                    | Río Negro                    |
| San Juan de la Costa         | San Juan de la Costa         |
| San Pablo                    | San Pablo                    |
| Aisén                        | Aisén                        |
| Chile Chico                  | Chile Chico                  |
| Cisnes                       | Cisnes                       |
| Cochrane                     | Cochrane                     |
| Coihaique                    | Coihaique                    |
| Guaitecas                    | Guaitecas                    |
| Lago Verde                   | Lago Verde                   |
| O’Higgins                    | O’Higgins                    |
| Río Ibáñez                   | Río Ibáñez                   |
| Tortel                       | Tortel                       |
| Antártica                    | Antártica                    |
| Cabo de Hornos (Ex Navarino) | Cabo de Hornos (Ex Navarino) |
| Laguna Blanca                | Laguna Blanca                |
| Natales                      | Natales                      |
| Porvenir                     | Porvenir                     |
| Primavera                    | Primavera                    |
| Punta Arenas                 | Punta Arenas                 |
| Río Verde                    | Río Verde                    |
| San Gregorio                 | San Gregorio                 |
| Timaukel                     | Timaukel                     |
| Torres del Paine             | Torres del Paine             |
| {% endtab %}                 |                              |

{% tab title="Estado civil (PE)" %}

| Valor         | Descrição  |
| ------------- | ---------- |
| solteiro      | Solteiro   |
| casado        | Casado     |
| convivente    | Convivente |
| divorciado    | Divorciado |
| viúvo         | Viúvo      |
| {% endtab %}  |            |
| {% endtabs %} |            |

### 2.2. Registro de nível avançado

{% tabs %}
{% tab title="cURL" %}

```bash
POST /api/nb/account/register HTTP/1.1
Host: https://api.notbank.com
Content-Type: application/json
aptoken: <token>

{
  // incluir todos os parâmetros do registro básico mais os seguintes parâmetros:
  "pep": false,  // é uma pessoa politicamente exposta
  "is_public_servant": true,  // é servidor público
  "subject_comply": false,  // é sujeito obrigado
}

---

{
  "status": "success",
  "data": {
    "userId": "<client-user-id>",
    "token": "<client-jwt>"
  }
}
```

{% endtab %}
{% endtabs %}

## 3. Obter contas

**Notbank** oferece diferentes tipos de contas: a **conta primária**, pensada para suas operações do dia a dia, a **conta yield**, projetada para que seu dinheiro trabalhe e gere rendimentos. Além disso, você pode criar **múltiplas subcontas**, o que permite manter seus saldos perfeitamente organizados — separando, por exemplo, seus fundos operacionais de suas economias.

{% hint style="warning" %}
Se precisar realizar a operação na conta do seu cliente, deve incluir os parâmetros `user_id` retornado no registro e o valor do parâmetro  `account_id`  deve ser a conta do seu cliente. Caso contrário, somente sua `account_id` e a operação será feita sobre o usuário autenticado.
{% endhint %}

{% tabs %}
{% tab title="cURL" %}

```bash
GET /api/nb/account?user_id=<clientUserId>&account_id=<clientAccountId> HTTP/1.1
Host: https://api.notbank.com
aptoken: <token>

----

{
  "status": "success",
  "data": [
    {
      "id": 12345,  // account_id
      "type": 1,
    }, ...
  ]
}
```

{% endtab %}
{% endtabs %}

### 3.1 Glossário

{% tabs %}
{% tab title="Tipo de conta" %}

| Valor         | Descrição              |
| ------------- | ---------------------- |
| 1             | Conta primária. Única. |
| 3             | Conta yield. Única.    |
| 5             | Subconta. Múltiplas.   |
| {% endtab %}  |                        |
| {% endtabs %} |                        |

## 4. Receber e enviar criptomoedas

As carteiras de criptomoedas da **Notbank** oferecem uma porta de entrada segura e acessível para o dinâmico mundo dos ativos digitais. Projetadas para atender tanto a novatos quanto a investidores experientes, destacam-se por sua ampla compatibilidade, que abrange uma grande **variedade de moedas e redes** líderes do mercado, permitindo que os usuários gerenciem seu portfólio em um único lugar prático. Um ponto-chave da Notbank é seu compromisso com a rentabilidade do usuário, oferecendo **tarifas econômicas** que otimizam cada transação. Além disso, a segurança é a prioridade máxima; com o respaldo da Notbank, essas carteiras incorporam protocolos de proteção de última geração e medidas de segurança avançadas para garantir que os fundos e a privacidade dos usuários estejam protegidos o tempo todo.

### 4.1. Criar uma carteira para receber criptomoedas

#### 4.1.1 Obter as redes disponíveis

Dada a grande quantidade de moedas e redes suportadas pela Notbank, primeiro é necessário obter as redes disponíveis para uma criptomoeda.

{% tabs %}
{% tab title="cURL" %}

```bash
GET /api/nb/wallet/crypto/withdrawal/templates?currency=USDT HTTP/1.1
Host: https://api.notbank.com
aptoken: <token>

----

{
  "status": "success",
  "data": [
    {
      "currency": "USDT",
      "network": "USDT_ETH",
      "network_name": "Ethereum",
      "network_protocol": "ERC-20",
      "template": [...]
    }, ...
  ]
}
```

{% endtab %}

{% tab title="Node" %}

```js
// ...
const networks = await restClient.getWalletService().getNetworksTemplates({
  currency: "USDT"
});

console.log(networks);
// [
//   {
//     currency: 'USDT',
//     network: 'USDT_BSC',
//     network_name: 'BNB Smart Chain',
//     network_protocol: 'BEP-20',
//     template: [
//       [Object],
//       [Object]
//     ]
//   }
// ]
```

{% endtab %}
{% endtabs %}

#### 4.1.2 Obter uma carteira

Usando o código da rede ( `network` ) obtido na etapa anterior mais o código da moeda (`currency`) você pode solicitar o endereço da sua carteira.&#x20;

{% hint style="warning" %}
Se precisar realizar a operação na conta do seu cliente, deve incluir os parâmetros `user_id` retornado no registro e o valor do parâmetro  `account_id`  deve ser a conta do seu cliente. Caso contrário, somente sua `account_id` e a operação será feita sobre o usuário autenticado.
{% endhint %}

{% tabs %}
{% tab title="cURL" %}

```bash
GET /api/nb/wallet/crypto?user_id=clientUserId&account_id=clientAccountId&currency=USDT&network=USDT_ETH HTTP/1.1
Host: https://api.notbank.com
aptoken: <token>

----

{
  "status": "success",
  "data": [
    "2N3r9roRrHy7p6C5pGE8NQP9ZNT81H7ZKyU"
  ]
}
```

{% endtab %}

{% tab title="Node" %}

```js
// ...
const addresses = await restClient.getWalletService().getDepositAddresses({
  user_id: clientUserId
  account_id: clientAccountId,
  currency: "USDT",
  network: "USDT_ETH",
});

console.log(addresses)
// ["2N3r9roRrHy7p6C5pGE8NQP9ZNT81H7ZKyU"]
```

{% endtab %}
{% endtabs %}

### 4.2 Adicionar endereço à lista de permissões

Para garantir a máxima segurança dos seus ativos, na Notbank é necessário registrar previamente os endereços de destino em uma lista de permissões antes de realizar qualquer transferência de criptomoedas. Esta medida adicional de proteção ajuda a prevenir saques não autorizados e garante que seus fundos sejam enviados somente para carteiras confiáveis verificadas por você.

#### 4.2.1 Adicionar um endereço

{% hint style="warning" %}
Se precisar realizar a operação na conta do seu cliente, deve incluir os parâmetros `user_id` retornado no registro e o valor do parâmetro  `account_id`  deve ser a conta do seu cliente. Caso contrário, somente sua `account_id` e a operação será feita sobre o usuário autenticado.
{% endhint %}

{% tabs %}
{% tab title="Node" %}

```js
// ...
const whitelistAddressId = await restClient.getWalletService().addWhitelistedAddress({
  user_id: clientUserId
  account_id: clientAccountId,
  currency: "USDT",
  network: "USDT_ETH",
  address: "2N3r9roRrHy7p6C5pGE8NQP9ZNT81H7ZKyU",
  label: "test-address-name",
  otp: "123456"
});

console.log(whitelistAddressId);
// f3d1ddc3-2767-4b99-8763-a0990361009d
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
O valor do parâmetro `otp` corresponde ao código de autenticação de dois fatores que seu aplicativo externo fornece no momento em que você solicita o envio.
{% endhint %}

{% hint style="info" %}
A Notbank enviará um **código de confirmação** para o seu número de telefone, com o qual você terá que confirmar o novo endereço que está adicionando à lista de permissões.
{% endhint %}

#### 4.2.2 Confirmar um endereço

{% hint style="warning" %}
Se precisar realizar a operação na conta do seu cliente, deve incluir os parâmetros `user_id` retornado no registro e o valor do parâmetro  `account_id`  deve ser a conta do seu cliente. Caso contrário, somente sua `account_id` e a operação será feita sobre o usuário autenticado.
{% endhint %}

{% tabs %}
{% tab title="Node" %}

<pre class="language-js"><code class="lang-js">// ...
await restClient.getWalletService().confirmWhitelistedAddress({
<strong>  user_id: clientUserId
</strong>  account_id: clientAccountId,
  whitelistedAddressId: "f3d1ddc3-2767-4b99-8763-a0990361009d",
  sms_code: "1234567",
});
</code></pre>

{% endtab %}
{% endtabs %}

### 4.3. Enviar suas criptomoedas para outra carteira

{% hint style="warning" %}
Se precisar realizar a operação na conta do seu cliente, deve incluir os parâmetros `user_id` retornado no registro e o valor do parâmetro  `account_id`  deve ser a conta do seu cliente. Caso contrário, somente sua `account_id` e a operação será feita sobre o usuário autenticado.
{% endhint %}

{% tabs %}
{% tab title="cURL" %}

```bash
POST /api/nb/wallet/crypto/withdrawal HTTP/1.1
Host: https://api.notbank.com
aptoken: <token>
Content-Type: application/json

{
  "user_id": clientUserId,
  "account_id": clientAccountId,
  "currency": "USDT",
  "network": "USDT_BSC",
  "address": "2N3r9roRrHy7p6C5pGE8NQP9ZNT81H7ZKyU",
  "amount": 12.3,
  "otp": "123456"
}

----

{
  "status": "success",
  "data": "0ea47288-76dd-4dd5-a544-e8af547ed3c7"
}
```

{% endtab %}

{% tab title="Node" %}

```js
// ...
const withdraw = await restClient.getWalletService().createCryptoWithdraw({
  user_id: clientUserId
  account_id: clientAccountId,
  currency: "USDT",
  network: "USDT_BSC",
  address: "2N3r9roRrHy7p6C5pGE8NQP9ZNT81H7ZKyU",
  amount: 12.3,
  otp: "123456"
});

console.log(withdraw);
// 0ea47288-76dd-4dd5-a544-e8af547ed3c7
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
O valor do parâmetro `otp` corresponde ao código de autenticação de dois fatores que seu aplicativo externo fornece no momento em que você solicita o envio.
{% endhint %}

## 5. Transferir fundos

### 5.1 Transferir fundos usando os identificadores de conta

Neste exemplo, vamos solicitar uma transferência de `1000` `USDT` da sua conta `accountId` para a conta do seu cliente `clientAccountId` .

{% tabs %}
{% tab title="cURL" %}

```bash
POST /api/nb/wallet/transfer-funds HTTP/1.1
Host: https://api.notbank.com
aptoken: <token>
Content-Type: application/json

{
  "sender_account_id": accountId,
  "receiver_account_id": clientAccountId,
  "currency_name": "USDT",
  "amount": "1000",
  "notes": "Nota de teste",  // opcional
  "otp": "123456"
}

----

{
  "status": "success",
  "data": 12345 // identificador da transferência
}
```

{% endtab %}

{% tab title="Node" %}

```js
import Notbank from 'notbank'

const transferId = await restClient.getWalletService().transferFunds({
  "sender_account_id": accountId,
  "receiver_account_id": clientAccountId,
  "currency_name": "USDT",
  "amount": 1000,
  "notes": "Nota de teste",
  "otp": "123456"
});

console.log(transferId)
// 12345
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
O valor do parâmetro `otp` corresponde ao código de autenticação de dois fatores que seu aplicativo externo fornece no momento em que você solicita o envio.
{% endhint %}

## 6. Comprar, vender e converter criptomoedas

Descubra **Simple**, a funcionalidade criada para que a compra, venda e conversão de criptomoedas seja uma experiência simples, rápida e segura para todos. Esqueça interfaces complexas e tipos de ordens; com o Simple, você pode executar suas transações de forma intuitiva em poucos passos. Esta ferramenta é perfeita tanto para quem está começando no mundo cripto quanto para usuários avançados que buscam velocidade. Além da facilidade de uso, o Simple se destaca por oferecer uma taxa de transação econômica, permitindo que você otimize suas operações e fazendo com que sua entrada no mercado cripto seja não apenas eficiente, mas também acessível.

### 6.1 Comprar criptomoedas com moeda fiduciária

Neste exemplo, vamos solicitar a quantidade de Tether (USDT) que receberíamos se usássemos R$ 100.000 reais brasileiros (BRL). Depois consultaremos o valor prometido, que tem validade de 20 segundos e, por fim, executaremos a compra.

{% hint style="info" %}
Os valores apresentados nos exemplos são para fins educacionais e não representam o estado atual do mercado.
{% endhint %}

#### 6.1.1 Solicitar cotação

{% hint style="warning" %}
Se precisar realizar a operação na conta do seu cliente, deve incluir os parâmetros `user_id` retornado no registro e o valor do parâmetro  `account_id`  deve ser a conta do seu cliente. Caso contrário, somente sua `account_id` e a operação será feita sobre o usuário autenticado.
{% endhint %}

{% tabs %}
{% tab title="Node" %}

```js
const quoteId = await restClient.getQuoteService().createDirectQuote({
  from_currency: "BRL",
  from_amount: 100000,
  to_currency: "USDT",
  operation: 1, // COMPRA
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quoteId)
// c1c56ca3-75c3-4bb6-97e3-702448382cd3
```

{% endtab %}
{% endtabs %}

#### 6.1.2 Consultar cotação

{% hint style="warning" %}
Se precisar realizar a operação na conta do seu cliente, deve incluir os parâmetros `user_id` retornado no registro e o valor do parâmetro  `account_id`  deve ser a conta do seu cliente. Caso contrário, somente sua `account_id` e a operação será feita sobre o usuário autenticado.
{% endhint %}

{% tabs %}
{% tab title="Node" %}

```js
// ...
const quote = await restClient.getQuoteService().getQuote({
  quote_id: "c1c56ca3-75c3-4bb6-97e3-702448382cd3",
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quote.status)
// 0 // pendente
console.log(quote.amount_out)
// 0.0013 // USDT
```

{% endtab %}
{% endtabs %}

#### 6.1.3 Executar cotação

{% hint style="warning" %}
Se precisar realizar a operação na conta do seu cliente, deve incluir os parâmetros `user_id` retornado no registro e o valor do parâmetro  `account_id`  deve ser a conta do seu cliente. Caso contrário, somente sua `account_id` e a operação será feita sobre o usuário autenticado.
{% endhint %}

{% tabs %}
{% tab title="Node" %}

```js
// ...
const quote = await client.getQuoteService().executeQuote({
  quote_id: "c1c56ca3-75c3-4bb6-97e3-702448382cd3",
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quote.status)
// 0 // pendente
console.log(quote.amount_out)
// 0.0013 // USDT

// Depois de alguns momentos, consultar novamente o status da solicitação
const quote = await restClient.getQuoteService().getQuote({
  quote_id: "c1c56ca3-75c3-4bb6-97e3-702448382cd3",
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quote.status)
// 1 // executado
console.log(quote.amount_out)
// 0.0013 // USDT
```

{% endtab %}
{% endtabs %}

### 6.2 Vender criptomoedas por moeda fiduciária

Neste exemplo, vamos solicitar a quantidade de reais brasileiros (BRL) que receberíamos se usássemos 0.0013 Tether (USDT). Depois consultaremos o valor prometido, que tem validade de 20 segundos e, por fim, executaremos a compra.

{% hint style="info" %}
Os valores apresentados nos exemplos são para fins educacionais e não representam o estado atual do mercado.
{% endhint %}

#### 6.2.1 Solicitar cotação

{% hint style="warning" %}
Se precisar realizar a operação na conta do seu cliente, deve incluir os parâmetros `user_id` retornado no registro e o valor do parâmetro  `account_id`  deve ser a conta do seu cliente. Caso contrário, somente sua `account_id` e a operação será feita sobre o usuário autenticado.
{% endhint %}

{% tabs %}
{% tab title="Node" %}

```js
const quoteId = await restClient.getQuoteService().createDirectQuote({
  from_currency: "USDT",
  from_amount: 0.0013,
  to_currency: "BRL",
  operation: 2, // VENDA
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quoteId)
// 1b09948d-2169-4f93-84ec-a55fb1741663
```

{% endtab %}
{% endtabs %}

#### 6.2.2 Consultar cotação

{% hint style="warning" %}
Se precisar realizar a operação na conta do seu cliente, deve incluir os parâmetros `user_id` retornado no registro e o valor do parâmetro  `account_id`  deve ser a conta do seu cliente. Caso contrário, somente sua `account_id` e a operação será feita sobre o usuário autenticado.
{% endhint %}

{% tabs %}
{% tab title="Node" %}

```js
// ...
const quote = await restClient.getQuoteService().getQuote({
  quote_id: "c1c56ca3-75c3-4bb6-97e3-702448382cd3",
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quote.status)
// 0 // pendente
console.log(quote.amount_out)
// 100000 // BRL
```

{% endtab %}
{% endtabs %}

#### 6.2.3 Executar cotação

{% hint style="warning" %}
Se precisar realizar a operação na conta do seu cliente, deve incluir os parâmetros `user_id` retornado no registro e o valor do parâmetro  `account_id`  deve ser a conta do seu cliente. Caso contrário, somente sua `account_id` e a operação será feita sobre o usuário autenticado.
{% endhint %}

{% tabs %}
{% tab title="Node" %}

```js
// ...
const quote = await client.getQuoteService().executeQuote({
  quote_id: "1b09948d-2169-4f93-84ec-a55fb1741663",
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quote.status)
// 0 // pendente
console.log(quote.amount_out)
// 100000 // BRL

// Depois de alguns momentos, consultar novamente o status da solicitação
const quote = await restClient.getQuoteService().getQuote({
  quote_id: "1b09948d-2169-4f93-84ec-a55fb1741663",
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quote.status)
// 1 // executado
console.log(quote.amount_out)
// 100000 // BRL
```

{% endtab %}
{% endtabs %}

### 6.3 Converter criptomoedas

**A Notbank oferece duas modalidades de cotação para converter moedas.** Com a cotação direta, basta inserir o valor que deseja converter e selecionar a moeda de origem e a moeda de destino; o sistema mostrará imediatamente quanto dinheiro você receberá na moeda final. A cotação inversa funciona ao contrário: você informa o valor que precisa receber na moeda de destino e especifica a moeda de origem, e o sistema calcula automaticamente quanto dinheiro você precisa na moeda original para obter exatamente esse valor. Dessa forma, você pode escolher a opção que melhor se adapte à sua necessidade: calcular o resultado de uma conversão ou determinar quanto você precisa ter na moeda de partida.

{% hint style="success" %}
A conversão não se limita a transações entre criptomoedas, mas a qualquer combinação possível: criptomoeda para criptomoeda, moeda fiduciária para criptomoeda, criptomoeda para moeda fiduciária e moeda fiduciária para moeda fiduciária.
{% endhint %}

{% hint style="info" %}
Os valores apresentados nos exemplos são para fins educacionais e não representam o estado atual do mercado.
{% endhint %}

#### 6.3.1 Solicitar cotação

{% hint style="warning" %}
Se precisar realizar a operação na conta do seu cliente, deve incluir os parâmetros `user_id` retornado no registro e o valor do parâmetro  `account_id`  deve ser a conta do seu cliente. Caso contrário, somente sua `account_id` e a operação será feita sobre o usuário autenticado.
{% endhint %}

Neste exemplo, vamos solicitar a quantidade de Tether (USDT) que receberíamos se utilizássemos 1 Bitcoin (BTC). Depois consultaremos o valor prometido, que tem validade de 20 segundos e, por fim, executaremos a compra.

{% tabs %}
{% tab title="Node" %}

```js
// cotação direta
const quoteId = await restClient.getQuoteService().createDirectQuote({
  from_currency: "BTC",
  from_amount: 1,
  to_currency: "USDT",
  operation: 3, // CONVERSÃO
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quoteId)
// fc4ffe0e-b87a-4e1f-a727-f6ddae7dc1e0
```

{% endtab %}
{% endtabs %}

Neste exemplo, vamos solicitar a quantidade de Bitcoin (BTC) que precisaríamos se quiséssemos 100 Tether (USDT). Depois consultaremos o valor prometido, que tem validade de 20 segundos e, por fim, executaremos a compra.

{% tabs %}
{% tab title="Node" %}

```js
// cotação inversa
const quoteId = await restClient.getQuoteService().createInverseQuote({
  from_currency: "BTC",
  to_amount: 100,
  to_currency: "USDT",
  operation: 3, // CONVERSÃO
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quoteId)
// fc4ffe0e-b87a-4e1f-a727-f6ddae7dc1e0
```

{% endtab %}
{% endtabs %}

#### 6.3.2 Consultar cotação

{% hint style="warning" %}
Se precisar realizar a operação na conta do seu cliente, deve incluir os parâmetros `user_id` retornado no registro e o valor do parâmetro  `account_id`  deve ser a conta do seu cliente. Caso contrário, somente sua `account_id` e a operação será feita sobre o usuário autenticado.
{% endhint %}

{% tabs %}
{% tab title="Node" %}

```js
// ...
const quote = await restClient.getQuoteService().getQuote({
  quote_id: "fc4ffe0e-b87a-4e1f-a727-f6ddae7dc1e0",
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quote.status)
// 0 // pendente
console.log(quote.amount_out)
// 30 // USDT
```

{% endtab %}
{% endtabs %}

#### 6.3.3 Executar cotação

{% hint style="warning" %}
Se precisar realizar a operação na conta do seu cliente, deve incluir os parâmetros `user_id` retornado no registro e o valor do parâmetro  `account_id`  deve ser a conta do seu cliente. Caso contrário, somente sua `account_id` e a operação será feita sobre o usuário autenticado.
{% endhint %}

{% tabs %}
{% tab title="Node" %}

```js
// ...
const quote = await client.getQuoteService().executeQuote({
  quote_id: "fc4ffe0e-b87a-4e1f-a727-f6ddae7dc1e0",
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quote.status)
// 0 // pendente
console.log(quote.amount_out)
// 30 // USDT

// Depois de alguns momentos, consultar novamente o status da solicitação
const quote = await restClient.getQuoteService().getQuote({
  quote_id: "fc4ffe0e-b87a-4e1f-a727-f6ddae7dc1e0",
  user_id: clientUserId
  account_id: clientAccountId,
});

console.log(quote.status)
// 1 // executado
console.log(quote.amount_out)
// 30 // USDT
```

{% endtab %}
{% endtabs %}

## 7. Depositar e retirar moeda fiduciária

Para facilitar a gestão dos seus fundos, a Notbank oferece aos seus usuários uma ampla variedade de métodos de pagamento projetados para atender às suas necessidades. Os clientes podem carregar saldo em moeda fiduciária em suas contas de maneira rápida e segura, selecionando entre opções tradicionais como transferências bancárias, o uso de cartões de crédito ou a integração com modernas gateways de pagamento. Essa flexibilidade garante que cada usuário possa gerenciar seu capital com total comodidade e sob os mais altos padrões de segurança financeira.

### 7.1 Obter contas bancárias de depósito

A Notbank oferece um serviço para obter as contas bancárias da Notbank de uso `geral`, às quais os clientes devem depositar para poder atribuir saldo às suas carteiras de moeda local.

{% hint style="info" %}
**IMPORTANTE**: Utilizar contas bancárias que estejam associadas à mesma identidade verificada na Notbank para uma correta atribuição do saldo.
{% endhint %}

{% tabs %}
{% tab title="HTTP" %}

```bash
GET /api/nb/bank-deposits?user_id=clientUserId HTTP/1.1
Host: https://api.notbank.com
Content-Type: application/json
aptoken: <ap-token>

---

{
  "status": "success",
  "data": [
    {
      "id": "41d63634-2f2a-47b8-8dd5-55b81fe87243",
      "currency": "CLP",
      "bank": "BCI (BCO DE CREDITO E INV)",
      "identity_number": "76.590.133-2",
      "identity_type": "RUT",
      "company_name": "CryptoMKT SpA",
      "account_type": "Conta corrente",
      "account_number": "32782381",
      "agency": null,
      "email": "transferencias@cryptomkt.com",
      "created_at": "2026-07-31T15:57:08",
      "updated_at": "2026-07-31T15:57:08"
    },
    {
      "id": "5885ce0e-474e-4e7d-b499-28cca702c58d",
      "currency": "ARS",
      "bank": "BANCO COINAG S.A.",
      "identity_number": "30715538063",
      "identity_type": "CUIT",
      "company_name": "Cryptomkt S.A.",
      "account_type": "Conta virtual",
      "account_number": "0000053600000000890630",
      "agency": null,
      "email": "transferencias@cryptomkt.com",
      "created_at": "2026-07-31T16:16:08",
      "updated_at": "2026-07-31T16:16:08"
    },
    {
      "id": "8f8877b6-2495-4ee9-81bd-100dd9089235",
      "currency": "BRL",
      "bank": "BANCO GENIAL S.A. (ex BRASIL PLURAL S.A.)",
      "identity_number": "28183128000157",
      "identity_type": "CNPJ",
      "company_name": "CRYPTOMKT SERVICOS DIGITAIS LTDA",
      "account_type": "Pessoa jurídica",
      "account_number": "4351-6",
      "agency": "0001",
      "email": "transferencias@cryptomkt.com",
      "created_at": "2026-07-31T16:18:46",
      "updated_at": "2026-07-31T16:18:46"
    },
    {
      "id": "fe85a901-0351-4f5b-8f7f-ea8439c02dfe",
      "currency": "PEN",
      "bank": "DALE",
      "identity_number": "20606503858",
      "identity_type": "RUC",
      "company_name": "CryptoMKT Peru SAC",
      "account_type": "Conta de dinheiro eletrônico",
      "account_number": "92200200000336442611",
      "agency": null,
      "email": "transferencias@cryptomkt.com",
      "created_at": "2026-07-31T16:43:53",
      "updated_at": "2026-07-31T16:43:53"
    }
  ]
}
```

{% endtab %}
{% endtabs %}

#### 7.1.1 Obter contas bancárias de depósito virtuais ou FBO

{% hint style="warning" %}
**IMPORTANTE**: Em breve ofereceremos suporte para contas virtuais e FBO. **Este serviço ainda está em desenvolvimento**.&#x20;
{% endhint %}

As contas **virtuais** e **fbo**, são contas bancárias do cliente, mas gerenciadas pela Notbank. Essas contas terão um número de **conta único** por cliente, que poderá ser usado para depositar e sacar saldo em moedas locais.

{% tabs %}
{% tab title="HTTP" %}

```bash
GET /api/nb/bank-deposits?user_id=clientUserId HTTP/1.1
Host: https://api.notbank.com
Content-Type: application/json
aptoken: <ap-token>

---

{
  "status": "success",
  "data": [
    {
      "id": "41d63634-2f2a-47b8-8dd5-55b81fe87243",
      "type": "general",  // novo
      "currency": "CLP",
      "bank": "BCI (BCO DE CREDITO E INV)",
      "identity_number": "76.590.133-2",
      "identity_type": "RUT",
      "company_name": "CryptoMKT SpA",
      "account_type": "Conta corrente",
      "account_number": "32782381",
      "agency": null,
      "email": "transferencias@cryptomkt.com",
      "created_at": "2026-07-31T15:57:08",
      "updated_at": "2026-07-31T15:57:08"
    },
    {
      "id": "41d63634-2f2a-47b8-8dd5-55b81fe87243",
      "type": "virtual",  // novo
      "currency": "COP",
      "account_type": "virtual",  // novo
      "account_number": "12345678901234567890",
      "account_alias": null,  // novo
      "created_at": "2026-07-31T15:57:08",
      "updated_at": "2026-07-31T15:57:08"
    },
    {
      "id": "41d63634-2f2a-47b8-8dd5-55b81fe87243",
      "type": "fbo",  // novo
      "currency": "ARS",
      "account_type": "cvu",  // novo
      "account_number": "12345678901234567890",
      "account_alias": null,  // novo
      "created_at": "2026-07-31T15:57:08",
      "updated_at": "2026-07-31T15:57:08"
    },
    {
      "id": "41d63634-2f2a-47b8-8dd5-55b81fe87243",
      "type": "fbo",  // novo
      "currency": "USD",
      "account_type": "swift",  // novo
      "account_number": "40000010851",
      "account_alias": null,  // novo
      "created_at": "2026-07-31T15:57:08",
      "updated_at": "2026-07-31T15:57:08",
      "beneficiary": {  // novo
        "name": "beneficiary-name",
        "address": "beneficiary-address",
        "account_number": "40000010851",
        "bank": {
          "name": "bank-name",
          "swift": "XXXXXXXXXXX",
          "routing_number": "123456789"
        }
      },
      "intermediary_bank": {  // novo
        "name": "bank-name",
        "routing_number": "123456789",
        "bic_code": "XXXXXXXXXXX"
      }
    }
  ]
}
```

{% endtab %}
{% endtabs %}

### 7.2 Criar uma conta bancária de depósito virtual ou FBO

{% hint style="warning" %}
**IMPORTANTE**: Em breve ofereceremos suporte para contas virtuais e FBO. **Este serviço ainda está em desenvolvimento**.&#x20;
{% endhint %}

{% tabs %}
{% tab title="HTTP" %}

```bash
POST /api/nb/bank-deposits HTTP/1.1
Host: hostname goes here...
aptoken: 2c262ce0-aebf-4dcb-8a70-cd60506a9ac8
Content-Type: multipart/form-data

{
  "type": "fbo",
  "currency": "ARS",
  "user_id": clientUserId
}


---

{
  "status": "success",
  "message": "Solicitação recebida com sucesso."
}
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="HTTP" %}

```bash
POST /api/nb/bank-deposits HTTP/1.1
Host: hostname goes here...
aptoken: 2c262ce0-aebf-4dcb-8a70-cd60506a9ac8
Content-Type: multipart/form-data

{
  "type": "virtual",
  "currency": "COP",
  "account_number": "1234567890123",
  "user_id": clientUserId
}

---

{
  "status": "success",
  "message": "Solicitação recebida com sucesso."
}
```

{% endtab %}
{% endtabs %}

### 7.3 Editar o alias de uma conta bancária de depósito FBO

{% hint style="warning" %}
**IMPORTANTE**: Em breve ofereceremos suporte para contas virtuais e FBO. **Este serviço ainda está em desenvolvimento**.&#x20;
{% endhint %}

{% hint style="info" %}
**IMPORTANTE**: Método disponível apenas para contas **fbo** com a moeda **ARS**.
{% endhint %}

{% tabs %}
{% tab title="HTTP" %}

```bash
PATCH /api/nb/bank-deposits/02e82e3f-f200-41e9-a31b-81eaedc9cdc5 HTTP/1.1
Host: hostname goes here...
aptoken: 2c262ce0-aebf-4dcb-8a70-cd60506a9ac8
Content-Type: application/json

{
    "account_alias": "new-alias",
    "user_id": clientUserId
}

---

{
  "status": "success",
  "data": {
    "id": "02e82e3f-f200-41e9-a31b-81eaedc9cdc5",
    "type": "fbo",
    "account_number": "1231237817239817239",
    "account_alias": "new-alias",
    "account_type": "cvu",
    "currency": "ARS",
    "created_at": "2026-07-31T16:43:53",
    "updated_at": "2026-07-31T16:43:53"
  }
}
```

{% endtab %}
{% endtabs %}

### 7.4 Adicionar conta bancária

#### 7.4.1 Obter lista de bancos suportados

{% hint style="warning" %}
Se precisar realizar a operação na conta do seu cliente, deve incluir os parâmetros `user_id` retornado no registro e o valor do parâmetro  `account_id`  deve ser a conta do seu cliente. Caso contrário, somente sua `account_id` e a operação será feita sobre o usuário autenticado.
{% endhint %}

{% tabs %}
{% tab title="Node" %}

```js
// ...
const banks = await restClient.getWalletService().getBanks({
  country: "BR"
});

console.log(banks);
// {
//   "status": "success",
//   "data": [
//     {
//       "id": "9ad5a964-f91c-4a7d-8257-119c97cf960a",
//       "name": "CAIXA ECONOMICA FEDERAL",
//       "country": "BR"
//     }, ...
//   ]
// }

```

{% endtab %}
{% endtabs %}

#### 7.4.2 Adicionar conta bancária

{% hint style="warning" %}
Se precisar realizar a operação na conta do seu cliente, deve incluir os parâmetros `user_id` retornado no registro e o valor do parâmetro  `account_id`  deve ser a conta do seu cliente. Caso contrário, somente sua `account_id` e a operação será feita sobre o usuário autenticado.
{% endhint %}

{% tabs %}
{% tab title="Node" %}

```js
// ...
const userBankAccount =  restClient.getWalletService().AddClientBankAccount({
  user_id: clientUserId,
  country: "BR",
  bank: "9ad5a964-f91c-4a7d-8257-119c97cf960a",
  number: "55330450314",
  kind: "br_pix",
  pix_type: "CPF",  // Somente Brasil (BR)
  // agency: "",  // Somente Brasil (BR) se kind != br_pix
  // dv: "", // Somente Brasil (BR) se kind != br_pix
  // province?: string; Somente Peru (PE)
});

console.log(userBankAccount.id);
// 29cd83cf-3678-4207-80c7-7caaa1d24c27
```

{% endtab %}
{% endtabs %}

#### Glossário

{% tabs %}
{% tab title="Tipo de conta bancária" %}

| País                                                 | Valor                   | Descrição                         |
| ---------------------------------------------------- | ----------------------- | --------------------------------- |
| Argentina (AR), Chile (CL), Peru (PE), Colômbia (CO) | corrente                | Conta corrente                    |
| Argentina (AR), Chile (CL)                           | à vista                 | Conta à vista                     |
| Argentina (AR), Chile (CL), Peru (PE), Colômbia (CO) | poupança                | Conta de poupança                 |
| Argentina (AR), Chile (CL)                           | electronic\_checkbook   | Cheque eletrônico                 |
| Argentina (AR)                                       | ar\_cbu                 | Conta CBU                         |
| Argentina (AR)                                       | ar\_cvu                 | Conta CVU                         |
| Argentina (AR)                                       | ar\_alias               | Apelido                           |
| Brasil (BR)                                          | br\_corriente\_fisica   | Conta corrente de pessoa física   |
| Brasil (BR)                                          | br\_simple\_fisica      | Conta simples de pessoa física    |
| Brasil (BR)                                          | br\_corriente\_juridica | Conta corrente de pessoa jurídica |
| Brasil (BR)                                          | br\_poupanca\_fisica    | Conta poupança de pessoa física   |
| Brasil (BR)                                          | br\_poupanca\_juridica  | Conta poupança de pessoa física   |
| Brasil (BR)                                          | br\_caixa\_facil        | Conta Caixa Fácil                 |
| Brasil (BR)                                          | br\_pix                 | Conta PIX                         |
| {% endtab %}                                         |                         |                                   |

{% tab title="Tipo de conta PIX" %}

| Valor         | Descrição          |
| ------------- | ------------------ |
| CPF           | Número de CPF      |
| CNPJ          | Número de CNPJ     |
| E-mail        | Correio eletrônico |
| Telefone      | Número de telefone |
| Outro         | Outro              |
| {% endtab %}  |                    |
| {% endtabs %} |                    |

### 7.5 Notificar um depósito

Na Notbank, otimizamos o processo de recebimento de fundos para oferecer a você uma experiência ágil e segura na gestão dos seus ativos. Atualmente, admitimos a notificação de depósitos em moeda fiduciária por meio de **transferências bancárias** tradicionais para todos os países onde operamos, integrando também de forma exclusiva o método de **Webpay** para o Chile ou PIX para o Brasil, o que permite uma validação imediata e eficiente para os usuários dessa região. Estamos trabalhando continuamente para expandir nossas capacidades operacionais, por isso em breve adicionaremos novos métodos de pagamento à nossa API, oferecendo maior flexibilidade e alcance às nossas soluções financeiras globais.

#### 7.5.1 Notificação bancária

{% hint style="warning" %}
Se precisar realizar a operação na conta do seu cliente, deve incluir os parâmetros `user_id` retornado no registro e o valor do parâmetro  `account_id`  deve ser a conta do seu cliente. Caso contrário, somente sua `account_id` e a operação será feita sobre o usuário autenticado.
{% endhint %}

{% tabs %}
{% tab title="Node" %}

<pre class="language-js"><code class="lang-js">// ...
await restClient.getWalletService().createFiatDeposit({
<strong>  user_id: clientUserId,
</strong>  account_id: clientAccountId,  
  payment_method: 1,  // transferência bancária
  currency: "BRL",
  amount: 1000,
  bank_account_id: "29cd83cf-3678-4207-80c7-7caaa1d24c27",
  // voucher: File. Somente PE (Peru).
});
</code></pre>

{% endtab %}
{% endtabs %}

### 7.6 Notificar um saque

A Notbank garante uma experiência financeira global ao oferecer o serviço de saque de moeda fiduciária em todos os países onde a plataforma está presente, permitindo que os usuários convertam seus ativos digitais em dinheiro local de forma eficiente. No entanto, é importante destacar que existe um caso especial para a Argentina: devido a processos específicos de validação nessa região, é indispensável que o usuário confirme a notificação do saque dentro do aplicativo para concluir a transação com sucesso.

#### 7.6.1 Notificação de saque bancário

{% hint style="warning" %}
Se precisar realizar a operação na conta do seu cliente, deve incluir os parâmetros `user_id` retornado no registro e o valor do parâmetro  `account_id`  deve ser a conta do seu cliente. Caso contrário, somente sua `account_id` e a operação será feita sobre o usuário autenticado.
{% endhint %}

{% tabs %}
{% tab title="Node" %}

```js
await restClient.getWalletService().createFiatWithdraw({
  user_id: clientUserId,
  account_id: clientAccountId, 
  payment_method: 1,
  currency: "BRL",
  amount: 1000,
  bank_account_id: "29cd83cf-3678-4207-80c7-7caaa1d24c27"
});
```

{% endtab %}
{% endtabs %}

#### 7.6.2 Notificação de saque bancário na Argentina

Obter informações de uma conta CBU de destino

{% tabs %}
{% tab title="Node" %}

```js
// ...
const owners = await restClient.getWalletService().getOwnersFiatWithdraw({
  cbu: "6845784411100069899422"
});

console.log(owners);
// [
//   {
//     "person_type": "F",
//     "cuit": "número do CUIT",
//     "name": "Nome da pessoa"
//   }, ...
// ]
```

{% endtab %}
{% endtabs %}

Notificar um saque bancário

{% hint style="warning" %}
Se precisar realizar a operação na conta do seu cliente, deve incluir os parâmetros `user_id` retornado no registro e o valor do parâmetro  `account_id`  deve ser a conta do seu cliente. Caso contrário, somente sua `account_id` e a operação será feita sobre o usuário autenticado.
{% endhint %}

{% tabs %}
{% tab title="Node" %}

```js
// ...
const withdrawId = await restClient.getWalletService().createFiatWithdraw({
  user_id: clientUserId,
  account_id: clientAccountId, 
  payment_method: 1,
  currency: "ARS",
  amount: 1000,
  cbu: "6845784411100069899422",
  person_type: "F",
  cuit: "número do CUIT",
  name: "Nome da pessoa"
});

console.log(withdrawId);
// 32347216-4a4c-49ee-b0a5-1ad993fe522b
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
Quando você notificar um saque bancário, a Notbank enviará um código de confirmação para o seu e-mail, que depois você deve inserir na próxima etapa.
{% endhint %}

Confirmar um saque bancário

{% hint style="warning" %}
Se precisar realizar a operação na conta do seu cliente, deve incluir os parâmetros `user_id` retornado no registro e o valor do parâmetro  `account_id`  deve ser a conta do seu cliente. Caso contrário, somente sua `account_id` e a operação será feita sobre o usuário autenticado.
{% endhint %}

{% tabs %}
{% tab title="Node" %}

```js
// ...
await restClient.getWalletService().confirmFiatWithdraw({
  user_id: clientUserId,
  withdrawal_id: "32347216-4a4c-49ee-b0a5-1ad993fe522b",
  attempt_code: 123456
});
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://www.notbank.com/learn/tutorial/pt-br/crypto-as-a-service-com-reliance.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
