Ctrlk
Useful links
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Perfil

Requisitos de autenticação:

  • Endpoints regulares usam OAuth2 autenticação com URL base: https://api.us.prd.caf.io

  • Para maior segurança, alguns endpoints também podem suportar mTLS autenticação com URL base: https://mtls.us.prd.caf.io

  • Para informações sobre a implementação de mTLS, acesse Usando mTLS

As atualizações de perfil acionarão um webhook para comunicar novos status ao cliente-servidor. Veja mais em seção de webhooks do perfil

É importante ter cuidado, pois nem todas as propriedades podem estar presentes na resposta da solicitação, já que os dados do perfil mudam de acordo com a definição do modelo de consulta, modificando principalmente fontes campo.

Get person

get
/peoples/{personId}

Retrieve information of a person's profile.

Permission required: Read People Profiles

Parâmetros de rota
personIdstringObrigatório

Person identifier or CPF.

Parâmetros de cabeçalho
AuthorizationstringObrigatório

Your access token. See more in the 'Authentication' topic of this section.

Example: Bearer YOUR_TOKEN
Respostas
200

Success

application/json
requestIdstringObrigatório

Unique identifier of request.

Example: 2b8f373-c462-4bbf-9a4f-8aeb7d71ec53
idstringObrigatório

Unique identifier of person.

Example: 5388a3e9a73b28000bba31a3
statusstring · enumObrigatório

Status of person profile. Possible values: APPROVED, REPROVED, PENDING, PROCESSING, WAITING_DOCUMENTS

Example: APPROVEDValores possíveis:
cpfstringObrigatório

Individual person national registry.

Example: 00011122233
get/peoples/{personId}
GET /v1/profiles/peoples/{personId} HTTP/1.1
Host: api.us.prd.caf.io
Authorization: text
Accept: */*

{
  "requestId": "2b8f373-c462-4bbf-9a4f-8aeb7d71ec53",
  "id": "5388a3e9a73b28000bba31a3",
  "status": "APPROVED",
  "cpf": "00011122233",
  "basicData": {
    "name": "JANE DOE",
    "fatherName": "JOHN DOE",
    "motherName": "MARIA DOE",
    "birthDate": "01/01/2000",
    "rg": "115094374",
    "gender": "Female"
  },
  "executions": [
    {
      "executionId": "4w88a3e9a73b28000bba31ad",
      "executionOrigin": "API",
      "lastUpdate": "2022-09-08T22:11:05.816Z",
      "metadata": {}
    }
  ],
  "sources": {
    "pfAddresses": {
      "lastConsultation": {
        "date": "2022-09-08T22:11:05.816Z"
      },
      "data": {}
    },
    "pfBasicData": {
      "lastConsultation": {
        "date": "2022-09-08T22:11:05.816Z"
      },
      "data": {}
    },
    "pfMediaProfileAndExposure": {
      "lastConsultation": {
        "date": "2022-09-08T22:11:05.816Z"
      },
      "data": {}
    }
  }
}

Get company

get
/companies/{companyId}

Retrieve information of a company's profile.

Permission required: Read Company Profiles

Parâmetros de rota
companyIdstringObrigatório

Company identifier or CNPJ.

Parâmetros de consulta
_includeOnboardingQsastringOpcional

Should include corporate structure. Necessary to include sources response, onboarding and QSA.

Example: true
Parâmetros de cabeçalho
AuthorizationstringObrigatório

Your access token. See more in the 'Authentication' topic of this section.

Example: Bearer YOUR_TOKEN
Respostas
200

Success

application/json
requestIdstringObrigatório

Unique identifier of request.

Example: 2b8f373-c462-4bbf-9a4f-8aeb7d71ec53
idstringObrigatório

Unique identifier of company.

Example: 5388a3e9a73b28000bba31a3
statusstring · enumObrigatório

Status of company profile. Possible values: APPROVED, REPROVED, PENDING, PROCESSING, WAITING_DOCUMENTS

Example: APPROVEDValores possíveis:
cnpjstringObrigatório

National Register of Legal entity.

Example: 00AAA222333344
get/companies/{companyId}
GET /v1/profiles/companies/{companyId} HTTP/1.1
Host: api.us.prd.caf.io
Authorization: text
Accept: */*

{
  "requestId": "2b8f373-c462-4bbf-9a4f-8aeb7d71ec53",
  "id": "5388a3e9a73b28000bba31a3",
  "status": "APPROVED",
  "cnpj": "00AAA222333344",
  "basicData": {
    "openingDate": "01/01/2022",
    "officialName": "Official name example",
    "fantasyName": "Fantasy name example",
    "companySize": "MICRO EMPRESA",
    "companyEmail": "[email protected]",
    "mainActivity": "9511800 - Reparação e manutenção de computadores e de equipamentos periféricos",
    "secondaryActivities": [
      {
        "code": "6204000",
        "description": "Consultoria em tecnologia da informação"
      }
    ],
    "legalNature": "2135 - Empresário (Individual)",
    "status": "ATIVA",
    "jointStock": "R$ 1000,00",
    "phoneNumber": "555100001111"
  },
  "executions": [
    {
      "executionId": "4w88a3e9a73b28000bba31ad",
      "executionOrigin": "API",
      "lastUpdate": "2022-09-08T22:11:05.816Z",
      "metadata": {}
    }
  ],
  "onboarding": {
    "qsa": [
      {
        "status": "COMPLETED",
        "name": "Partner name example",
        "profileId": "1e48a3e9a73b28000bba31a2db",
        "transactionId": "1e48a3e9a73b28000bba31a2db"
      }
    ]
  },
  "qsa": {
    "items": [
      {
        "name": "Partner name example",
        "functionCode": "34",
        "function": "Titular",
        "isLegalRepresentative": true,
        "profileId": "1e48a3e9a73b28000bba31a2db",
        "status": "APPROVED",
        "transactionId": "1e48a3e9a73b28000bba31a2db"
      }
    ]
  },
  "sources": {
    "pjData": {
      "lastConsultation": {
        "date": "2022-09-08T22:11:05.816Z"
      },
      "data": {}
    },
    "pjSimples": {
      "lastConsultation": {
        "date": "2022-09-08T22:11:05.816Z"
      },
      "data": {}
    }
  }
}

Atualizado