API docs by Redocly

Atinio — API pública B2B (1.0.0)

Download OpenAPI specification:

API REST pra parceiros (imobiliárias) integrarem leads e lançamentos do Atinio. Cobre o caminho de LEITURA do MVP (/public/v1). Auth por API key escopada por parceiro. Dados pessoais de investidor só com consentimento + DPA assinado. Ver docs/api/partner-guide.md.

meta

Identidade da credencial

Prova a key e mostra partnerId, scopes e tipo de principal.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "partnerId": "string",
  • "scopes": [
    ],
  • "principal": {
    }
}

leads

Lista leads da imobiliária

Nunca retorna o userId do investidor. contact (nome/e-mail) só vem preenchido com consentimento; senão null. Telefone exige consentimento adicional. Exige DPA assinado.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "leads": [
    ]
}

Veredito do lead

Insight derivado dos sinais do investidor. Nunca expõe valores em reais nem recomendação personalizada de investimento (CVM 35/2021).

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "lead": {
    },
  • "verdict": {
    },
  • "launch": {
    },
  • "contact": {
    }
}

Histórico de eventos do lead

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "events": [
    ]
}

launches

Lista lançamentos da imobiliária

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "launches": [
    ]
}

Ficha de um lançamento

Lançamento de outra imobiliária retorna 404 (não vaza existência).

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "launch": {
    }
}

Sinais de interesse no lançamento

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }