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

Retrieve information of a person's profile.

get

/people/{personId}

Path parameters

personIdstringrequired

Person identifier or CPF.

Header parameters

Authorizationstringrequired

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

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.combateafraude.com/v1/people/{personId}' \
  --header 'Authorization: text'

200

400

401

403

200

{
  "requestId": "2b8f373-c462-4bbf-9a4f-8aeb7d71ec53",
  "id": "5388a3e9a73b28000bba31a3",
  "cpf": "00011122233",
  "status": "APPROVED",
  "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": {
      "data": {},
      "lastConsultation": {
        "date": "2022-09-08T22:11:05.816Z"
      }
    },
    "pfBasicData": {
      "data": {},
      "lastConsultation": {
        "date": "2022-09-08T22:11:05.816Z"
      }
    },
    "pfMediaProfileAndExposure": {
      "data": {},
      "lastConsultation": {
        "date": "2022-09-08T22:11:05.816Z"
      }
    }
  }
}

Success

Get company

Retrieve information of a company's profile.

get

/companies/{companyId}

Path parameters

companyIdstringrequired

Company identifier or CNPJ.

Query parameters

_includeOnboardingQsastring

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.

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.combateafraude.com/v1/companies/{companyId}' \
  --header 'Authorization: text'

200

400

401

403

200

{
  "requestId": "2b8f373-c462-4bbf-9a4f-8aeb7d71ec53",
  "id": "5388a3e9a73b28000bba31a3",
  "cnpj": "00111222333344",
  "status": "APPROVED",
  "executions": [
    {
      "executionId": "4w88a3e9a73b28000bba31ad",
      "executionOrigin": "API",
      "lastUpdate": "2022-09-08T22:11:05.816Z",
      "metadata": {}
    }
  ],
  "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",
    "legalNature": "2135 - Empresário (Individual)",
    "status": "ATIVA",
    "jointStock": "R$ 1000,00",
    "phoneNumber": "555100001111",
    "secondaryActivities": [
      {
        "code": "6204000",
        "description": "Consultoria em tecnologia da informação"
      }
    ]
  },
  "qsa": {
    "items": [
      {
        "name": "Partner name example",
        "functionCode": "34",
        "function": "Titular",
        "isLegalRepresentative": true,
        "profileId": "1e48a3e9a73b28000bba31a2db",
        "status": "APPROVED",
        "transactionId": "1e48a3e9a73b28000bba31a2db"
      }
    ]
  },
  "onboarding": {
    "qsa": [
      {
        "name": "Partner name example",
        "profileId": "1e48a3e9a73b28000bba31a2db",
        "transactionId": "1e48a3e9a73b28000bba31a2db",
        "status": "COMPLETED"
      }
    ]
  },
  "sources": {
    "pjData": {
      "data": {},
      "lastConsultation": {
        "date": "2022-09-08T22:11:05.816Z"
      }
    },
    "pjSimples": {
      "data": {},
      "lastConsultation": {
        "date": "2022-09-08T22:11:05.816Z"
      }
    }
  }
}

Success