Profile

Profile updates will trigger a webhook to communicate new statuses to the client-server. See more in profile webhooks section

It is significant to be careful that not all properties may be present in the request's response since the profile's data changes according to the query template definition, principally modifying the sources field.

Get person

get

Retrieve information of a person's profile.

Path parameters

personIdstringRequired

Person identifier or CPF.

Header parameters

AuthorizationstringRequired

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

Example: Bearer your_token_here

Responses

200

Success

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

HTTPcURLJavaScriptPython

GET /v1/people/{personId} HTTP/1.1
Host: api.combateafraude.com
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

Retrieve information of a company's profile.

Path parameters

companyIdstringRequired

Company identifier or CNPJ.

Query parameters

_includeOnboardingQsastringOptional

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

Example: true

Header parameters

AuthorizationstringRequired

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

Example: Bearer your_token_here

Responses

200

Success

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

HTTPcURLJavaScriptPython

GET /v1/companies/{companyId} HTTP/1.1
Host: api.combateafraude.com
Authorization: text
Accept: */*

{
  "requestId": "2b8f373-c462-4bbf-9a4f-8aeb7d71ec53",
  "id": "5388a3e9a73b28000bba31a3",
  "status": "APPROVED",
  "cnpj": "00111222333344",
  "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": {}
    }
  }
}