> For the complete documentation index, see [llms.txt](https://docs.caf.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.caf.io/caf-api/caf-api-pt-br/core-api/available-resources/onboarding.md).

# Integração

{% hint style="warning" %}
**Esta API está obsoleta.**

A Core API não é mais recomendada para novas integrações. Ela permanecerá funcional exclusivamente para clientes existentes. A migração para a [Connect API](/caf-api/caf-api-pt-br/connect/getting_started.md) é fortemente recomendada.

Para mais detalhes, consulte a [Política de descontinuação](/caf-api/caf-api-pt-br/deprecation-policy-for-resources.md).
{% endhint %}

## Integração

A integração é um fluxo web oferecido pela CAF para obter dados e documentos de pessoas ou empresas, proporcionando agilidade e simplicidade na integração de novos usuários. O produto foi projetado para atender a diferentes tipos de cadastro. Portanto, o fluxo/passos e o layout podem ser totalmente personalizados de acordo com a preferência do cliente. Além disso, permitimos a criação de modelos de integração ilimitados para que possam ser usados para diferentes finalidades.

O usuário final que precisa ser verificado iniciará as etapas de integração diretamente na página hospedada pela CAF, que lhe será apresentada por meio de uma URL de redirecionamento do cliente ou, alternativamente, por e-mail ou SMS (com o link de cadastro da CAF). Quando todas as etapas de cadastro definidas forem concluídas pelo usuário, uma transação será iniciada automaticamente com os dados obtidos, e a resposta de callback com os dados do resultado será enviada ao seu webhook pré-configurado.

Cada link de integração pode ser criado pela API ou pela CAF [Plataforma TRUST](https://trust.caf.io/dashboard) com associação a um template de onboarding e a um modelo de consulta de serviço pré-configurado.

{% openapi src="/files/ff46b17af858f852053796d805e24ab1a778cf7e" path="/onboardings" method="post" %}
[onboardings-create.yaml](https://262277803-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVxCOSyBojfSIE5fcpfH%2Fuploads%2Fgit-blob-7cca454d65366fa19234251a420d1a907205aa78%2Fonboardings-create.yaml?alt=media)
{% endopenapi %}


---

# 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://docs.caf.io/caf-api/caf-api-pt-br/core-api/available-resources/onboarding.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.