Esta API verifica o background de um individuo para diversos cenários. Em geral, sua chamada consiste em um corpo contendo o CPF ou CNPJ do individuo, bem como seu id interno, enquanto a resposta variará de acordo com o endpoint utilizado, que será baseado na consulta que deseja realizar.
\nCampos de entrada:
\n{\n \"customerId\": {costumer-id}, \n \"cpf\": {cpf}\n}\n\nAlém disso, no header da requisição será necessário informar a sua chave de API, que é atribuída após a contratação da ferramenta. A resposta do servidor para a chamada dependerá do endpoint usado. Os endpoints possíveis bem como suas respostas estão documentados abaixo.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"26382346","collectionId":"a7468ecc-9be3-44a5-acb6-e3318531d5a1","publishedId":"2sA2rGtJVo","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"058993","highlight":"07B6B4"},"publishDate":"2024-03-18T17:05:38.000Z"},"item":[{"name":"Documentação de API Certificação (pt-BR)","item":[{"name":"Certidão Negativa de Debitos Estadual","id":"7bbca3a7-1cf8-4ae1-892a-2f274fc4bdf6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\"customerId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\r\n \"certificationRequestId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\r\n \"cnpj\": \"03776595000160\",\r\n \"separateQuery\": true\r\n","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/cert-debt-absence-by-state-company-pj","description":"Este serviço realiza uma verificação de background para obter a Certidão Negativa de Débitos Estaduais de uma Pessoa Jurídica (PJ), com base em seu CNPJ.
\nO endpoint recebe uma requisição no formato JSON contendo os parâmetros descritos abaixo e retorna um objeto com informações relacionadas à certidão estadual da entidade consultada.
\ncustomerId: String que representa o identificador único do cliente.
\ncertificationRequestId: String contendo o identificador da requisição de certificação (CR).
\ncnpj: String contendo o CNPJ da pessoa jurídica a ser consultada.
\nseparateQuery: Flag booleana que indica se a consulta é avulsa. No painel de certificação, algumas consultas são realizadas dentro do fluxo da CR e outras são avulsas. Esta flag é utilizada para diferenciar os dois tipos.
\nParâmetros de entrada utilizados na consulta
\nQueryDate: Data em que a certidão foi emitida.
\nOnlineCertificates
\nOrigin: Fonte dos dados entregues. Para esta consulta, será sempre \"Certidão Negativa de Débitos Estaduais\".
\nInputParameters: Parâmetros de entrada utilizados na consulta.
\nProtocolNumber: Número de protocolo da certidão emitida.
\nBaseStatus: Status do documento consultado com relação aos débitos estaduais. Indica se a entidade possui ou não pendências.
\nAdditionalOutputData
\nIsInDebt: Flag que indica se a entidade possui débitos estaduais.
\nExpiration: Data de expiração da certidão emitida.
\nRawCertificateText: Conteúdo de texto “bruto” da certidão emitida, para conferência e registro.
\nRawResultFile: URL do arquivo da certidão emitida.
\nRawResultFileType: Tipo de arquivo do documento emitido.
\nA Certidão Negativa CNJ cobre condenações cíveis por improbidade administrativa e inelegibilidade, com base no cadastro de processos do Conselho Nacional de Justiça, processos estes que estariam já julgados ou com sanção ativa. Importante ressaltar que caso uma entidade tenha sido condenada por atos de improbidade administrativa, não necessariamente ela se torna inelegível de forma automática, para tal reconhecimento de ineligibilidade será preciso consultar no TSE. São retornados os dados da certidão 'on-demand' emitida, como status, número do protocolo e conteúdo da certidão, caso a consulta dessa certidão seja processada com sucesso.
\ncustomerId: String representando o identificador único do cliente.
\ncertificationRequestId: String contendo o identificador da requisição de certificação (CR).
\ncnpj: String contendo o CNPJ da pessoa jurídica a ser consultada.
\nseparateQuery: Flag booleana que indica se a consulta é avulsa. No painel de certificação, existem consultas realizadas dentro do fluxo da CR e consultas avulsas. Esta flag é utilizada para diferenciar os dois tipos.
\nParâmetros de entrada utilizados na consulta.
\nQueryDate: Data em que a certidão foi emitida.
\nOnlineCertificates
\nOrigin: Fonte dos dados entregues. Para esta consulta, será sempre \"Certidão Negativa de Débitos Estaduais\".
\nInputParameters: Parâmetros de entrada utilizados na consulta.
\nProtocolNumber: Número de protocolo da certidão emitida.
\nBaseStatus: Status do documento consultado com relação aos débitos estaduais. Indica se constam ou não pendências para a entidade.
\nAdditionalOutputData
\nIsInDebt: Flag indicando se a entidade possui débitos estaduais.
\nExpiration: Data de expiração da certidão emitida.
\nRawCertificateText: Conteúdo de texto “bruto” da certidão emitida, para conferência e registro.
\nRawResultFile: URL do arquivo da certidão emitida.
\nRawResultFileType: Tipo de arquivo do documento emitido.
\nEste serviço retorna, quando não existem débitos trabalhistas associados a entidade sendo consultada, uma certidão que comprova a não existência desses débitos. O endpoint recebe uma requisição no formato JSON, contendo um CNPJ válido, e retorna um objeto com os campos descritos abaixo. As informações retornadas nesta consulta são extraídas da consulta pública disponível no Superior Tribunal do Trabalho (TST).
\ncustomerId: String representando o identificador único do cliente.
\ncertificationRequestId: String contendo o identificador request.
\ncnpj: String contendo o CNPJ da pessoa jurídica.
\nCaso a operação seja bem-sucedida, será enviada uma resposta com os seguintes campos:
\nParâmetros de entrada utilizados na consulta.
\nQueryDate: Data em que a emissão da certidão foi efetuada.
\nOnlineCertificates
\nOrigin: Fonte dos Dados Entregues. Para essa consulta, será sempre \"Certidao Negativa de Debitos Trabalhistas\".
\nInputParameters: Parâmetros de entrada utilizados na consulta.
\nProtocolNumber: Número de protocolo da certidão emitida.
\nBaseStatus: Status do documento consultado com relação aos protestos. Indica se constam ou não débitos trabalhistas para entidade.
\nAdditionalOutputData
\nIsInDebt: Flag indicando se a entidade tem débitos trabalhistas ou não.
\nExpiration: Data de expiração da certidão emitida.
\nRawCertificateText: Conteúdo de texto \"bruto\" da certidão emitida, para conferência e registro.
\nRawResultFile: URL do arquivo da certidão emitida.
\nRrawResultFileType: Tipo de arquivo do documento emitido
\nRealiza a consulta dos dados básicos para pessoa física, como nome, idade e nacionalidade, a partir de seu CPF.
\nCampos de resposta:
\nRealiza a consulta do endereço de uma pessoa física a partir de seu CPF. A resposta da operação, caso bem sucedida, terá um campo addresses, que consiste em uma lista de objetos representando cada endereço cadastrado do indivíduo, conforme à seguir:
\nCampos de resposta:
\nRealiza a consulta dos endereços de e-mail para uma pessoa física a partir de seu CPF. A resposta da operação, caso bem sucedida, terá um campo emails, que consiste em uma lista de objetos representando cada endereço de e-mail cadastrado do indivíduo, conforme à seguir:
\nCampos de resposta:
\nRealiza a consulta de dados de telefone para uma pessoa física a partir de seu CPF. Caso bem sucedida, a operação retornará um campo telephones, que consiste em uma lista de objetos contendo cada número de telefone cadastrado do indivíduo, conforme à seguir:
\nCampos de resposta:
\nRealiza a consulta de dados fiscais para uma pessoa física a partir de seu CPF. Caso a operação seja bem sucedida, a operação retornará um campo taxReturns contendo uma lista de objetos com as informações fiscais do indivíduo para cada ano, conforme à seguir:
\nCampos de resposta:
\nRealiza a consulta de processos judiciais associados a uma pessoa física a partir de seu CPF. Caso a operação seja bem sucedida, ela retornará um campo lawsuits contendo uma lista de objetos com os processos judiciais, composto pelos seguintes campos:
\nCampos de resposta:
\nRealiza a consulta de dados da profissão de uma pessoa física a partir de seu CPF. Caso a operação seja bem sucedida, será retornado um campo professions contendo uma lista de objeto com as profissões registradas do indivíduo, conforme à seguir:
\nCampos de resposta:
\nRealiza a consulta de dados de crédito para uma pessoa física a partir de seu CPF.
\nCampos de Resposta:
\nRealiza a consulta de dados de telefone relacionados a uma pessoa física a partir de seu CPF. Caso bem sucedida, a operação terá um campo telephones contendo uma lista de objeto com as informações de cada número de telefone registrado associado ao indivíduo, bem como detalhes adicionais.
\nCampos de resposta:
\nRealiza a consulta de dados de risco financeiro para uma pessoa física a partir de seu CPF.
\nCampos de resposta:
\nRealiza a consulta de antecedentes criminais para uma pessoa física a partir de seu CPF. Caso bem sucedida, a consulta retornará um campo additionalOutputData contendo o certificado de antecedentes criminais emitido pela Polícia Federal, bem como informações adicionais.
\nCampos de resposta:
\nRealiza a consulta dos dados básicos cadastrais para pessoa jurídica a partir de seu CNPJ.
\nCampos de resposta:
\nRealiza a consulta de dados de débitos trabalhistas de FGTS de uma pessoa jurídica partir de seu CNPJ.
\nCampos de resposta:
\nRealiza a consulta de dados sobre os sócios de primeiro nível associados a um CNPJ. Caso bem sucedida, a operação retorna um campo firstLevelMembershipCircles contendo uma lista de objeto com as informações sobre os sócios de primeiro nível, conforme a seguir:
\nCampos de resposta:
\nEssa operação é responsável por validar as informações referentes aos apostadores. Se aplica aos apostadores que estão impedidos de apostar, afim de garantir o cumprimento rigoroso da lei 14.790/23, a qual estabelece requisitos essenciais de Conheça Seu Cliente (KYC) para apostas esportivas.
\nCampos de entrada:
\nCampos de respostas:
\nA partir do CPF de um indivíduo, consulta suas informações relacionadas a esportes, como equipes, campeonatos e familiares.
\nCampos de entrada:
\ncostumerId: Identificador do cliente.
\ncpf: Documento CPF identificador do indivíduo.
\nCampos de resposta:
\nsportName: Nome do esporte praticado pelo indivíduo.
\nregion: Região em que o indivíduo pratica o esporte.
\nrelatedEntities: Objeto contendo as informações relacionadas ao esportista.
\nrelationshipLevel: Tipo de relação com o indivíduo.
\ninstitutionName: Nome da instituição na qual o esportista está relacionado.
\ninstitutionActivity: Campo na qual a entidade atua.
\nrole: Atuação do indivíduo em relação a entidade.
\nisActive: Valor booleano indicando se o vinculo ainda está ativo.
\nstartDate: Data de início do vínculo.
\nendDate: Data de término do vínculo.
\nsource: Fonte na qual as informações foram obtidas.
\nOperação responsável pela consulta de pessoas expostas politicamente (PEP), sanções e restrições em âmbito nacional ou internacional. Além disso, indica se o indivíduo possui algum relacionamento familiar com uma pessoa politicamente exposta. A consulta é realizada a partir de seu CPF.
\nCampos de entrada:
\ncustumerID: Identificador do cliente.
\ncpf: Documento CPF identificador do indivíduo.
\nCampos de resposta:
\ncurrentlySanctioned: Indica se existem sanções ativas relacionadas ao CPF.
\npreviouslySanctioned: Indica se já houveram sanções relacionadas ao CPF.
\nlast30DaysSanctions: Valor numérico informando quantas sanções foram encontradas nos últimos 30 dias relacionadas ao CPF.
\nlast90DaysSanctions: Valor numérico informando quantas sanções foram encontradas nos últimos 90 dias relacionadas ao CPF.
\nlast180DaysSanctions: Valor numérico informando quantas sanções foram encontradas nos últimos 180 dias relacionadas ao CPF.
\nlast365DaysSanctions: Valor numérico informando quantas sanções foram encontradas nos últimos 365 dias relacionadas ao CPF.
\ncurrentlyPEP: Indica se o CPF atualmente está na lista de pessoas politicamente expostas ou se possui algum vínculo com alguém presente na lista.
\nlastYearOccurencePEP: Valor numérico indicando quantas vezes o CPF esteve exposto politicamente no último ano.
\nlast3YearsOccurencePEP: Valor numérico indicando quantas vezes o CPF esteve exposto politicamente nos últimos 3 anos.
\nlast5YearsOccurencePEP: Valor numérico indicando quantas vezes o CPF esteve exposto politicamente nos últimos 5 anos.
\nlast5PlusYearsOccurencePEP: Valor numérico indicando quantas vezes o CPF já esteve exposto politicamente.
\nhistoryPEP: Lista contendo informações sobre o histórico do indivíduo quanto a sua exposição na lista de PPE.
\nsanctionsHistory: Lista contendo informações sobre as sanções encontradas associadas ao CPF do indivíduo.
\nEste serviço realiza uma consulta de background check para obtenção da Certidão Negativa de Débitos Estaduais de uma Pessoa Jurídica (PJ), a partir do seu CNPJ.
\nO endpoint recebe uma requisição no formato JSON, contendo os parâmetros descritos abaixo, e retorna um objeto com as informações referentes à certidão estadual da entidade consultada.
\ncustomerId: String representando o identificador único do cliente.
\ncertificationRequestId: String contendo o identificador da requisição de certificação (CR).
\ncnpj: String contendo o CNPJ da pessoa jurídica a ser consultada.
\nseparateQuery: Flag booleana que indica se a consulta é avulsa. No painel de certificação, existem consultas realizadas dentro do fluxo da CR e consultas avulsas. Esta flag é utilizada para diferenciar os dois tipos.
\nCaso a operação seja bem-sucedida, será enviada uma resposta com os seguintes campos:
\nParâmetros de entrada utilizados na consulta.
\nQueryDate: Data em que a certidão foi emitida.
\nOnlineCertificates
\nOrigin: Fonte dos dados entregues. Para esta consulta, será sempre \"Certidão Negativa de Débitos Estaduais\".
\nInputParameters: Parâmetros de entrada utilizados na consulta.
\nProtocolNumber: Número de protocolo da certidão emitida.
\nBaseStatus: Status do documento consultado com relação aos débitos estaduais. Indica se constam ou não pendências para a entidade.
\nAdditionalOutputData
\nIsInDebt: Flag indicando se a entidade possui débitos estaduais.
\nExpiration: Data de expiração da certidão emitida.
\nRawCertificateText: Conteúdo de texto “bruto” da certidão emitida, para conferência e registro.
\nRawResultFile: URL do arquivo da certidão emitida.
\nRawResultFileType: Tipo de arquivo do documento emitido.
\nThis service returns a certificate confirming the absence of labor debts when no such debts are associated with the queried entity.
\nThe endpoint receives a JSON-formatted request containing a valid CNPJ and returns an object with the fields described below. The information provided in this query is extracted from the public consultation available on the Superior Labor Court (TST) website.
\ncustomerId: String representing the unique identifier of the customer.
\ncertificationRequestId: String containing the identifier of the certification request.
\ncnpj: String containing the CNPJ of the legal entity.
\nIf the operation is successful, the response will include the following fields:
\nInput parameters used in the query.
\nQueryDate: Date when the certificate was issued.
\nOnlineCertificates
\nOrigin: Source of the delivered data. For this query, it will always be \"Labor Debt Clearance Certificate\".
\nInputParameters: Input parameters used in the query.
\nProtocolNumber: Protocol number of the issued certificate.
\nBaseStatus: Status of the document regarding labor debts. Indicates whether or not there are labor-related debts associated with the entity.
\nAdditionalOutputData
\nIsInDebt: Flag indicating whether the entity has labor debts.
\nExpiration: Expiration date of the issued certificate.
\nRawCertificateText: Raw text content of the issued certificate, for verification and record purposes.
\nRawResultFile: URL of the issued certificate file.
\nRawResultFileType: File type of the issued document.
\nThe CNJ Negative Certificate covers civil convictions for administrative misconduct and ineligibility, based on the process registry of the National Council of Justice (Conselho Nacional de Justiça – CNJ). These are cases that have already been judged or have an active sanction.
\nIt is important to note that if an entity has been convicted of acts of administrative misconduct, it does not automatically become ineligible. To confirm ineligibility, a separate check must be made with the Superior Electoral Court (TSE).
\nThe service returns data from the on-demand issued certificate, such as its status, protocol number, and certificate content, provided the certificate query is successfully processed.
\ncustomerId: String representing the unique identifier of the customer.
\ncertificationRequestId: String containing the identifier of the Certification Request (CR).
\ncnpj: String containing the CNPJ of the legal entity to be queried.
\nseparateQuery: Boolean flag indicating whether the query is standalone. In the certification panel, there are queries performed within the CR flow and standalone ones. This flag is used to distinguish between the two types.
\nInput Parameters
\nParameters used in the query.
\nQueryDate: Date when the certificate was issued.
\nOnlineCertificates
\nOrigin: Source of the delivered data. For this query, it will always be \"Certidão Negativa de Débitos Estaduais\".
\nInputParameters: Parameters used in the query.
\nProtocolNumber: Protocol number of the issued certificate.
\nBaseStatus: Status of the consulted document in relation to state debts, indicating whether or not there are pending issues for the entity.
\nAdditionalOutputData
\nIsInDebt: Flag indicating whether the entity has outstanding state debts.
\nExpiration: Expiration date of the issued certificate.
\nRawCertificateText: Raw text content of the issued certificate, for verification and record purposes.
\nRawResultFile: URL of the issued certificate file.
\nRawResultFileType: File type of the issued document.
\nThis service performs a background check to obtain the State Debt Clearance Certificate (“Certidão Negativa de Débitos Estaduais”) for a Legal Entity (PJ), based on its CNPJ.
\nThe endpoint receives a JSON-formatted request containing the parameters described below and returns an object with information related to the state certificate of the queried entity.
\ncustomerId: String representing the unique identifier of the customer.
\ncertificationRequestId: String containing the identifier of the certification request (CR).
\ncnpj: String containing the CNPJ of the legal entity to be queried.
\nseparateQuery: Boolean flag indicating whether the query is standalone. In the certification panel, some queries are performed within the CR flow and others are standalone. This flag is used to distinguish between the two types.
\nIf the operation is successful, the response will include the following fields:
\nInput parameters used in the query.
\nQueryDate: Date when the certificate was issued.
\nOnlineCertificates
\nOrigin: Source of the delivered data. For this query, it will always be \"State Debt Clearance Certificate\".
\nInputParameters: Input parameters used in the query.
\nProtocolNumber: Protocol number of the issued certificate.
\nBaseStatus: Status of the document regarding state debts. Indicates whether or not the entity has outstanding debts.
\nAdditionalOutputData
\nIsInDebt: Flag indicating whether the entity has state debts.
\nExpiration: Expiration date of the issued certificate.
\nRawCertificateText: Raw text content of the issued certificate, for verification and record purposes.
\nRawResultFile: URL of the issued certificate file.
\nRawResultFileType: File type of the issued document.
\nChecks a Natural Person basic information, such as age, name and nationality using their CPF number.
\nResponse fields:
\nIt queries a Natural Person address using their CPF number. The response to the operation, if successful, will have an address field consisting of a list of objects representing each registered address of the individual, as listed:
\nResponse fields:
\nIt queries e-mail addresses for a Natural Person based on their CPF. The response to the operation, if successful, will have an e-mails field, which consists of a list of objects representing each of the individual's registered e-mail addresses, according to the list:
\nResponse fields:
\nIt queries telephone data for a Natural Person using their CPF. If successful, the operation will return a telephones field, which consists of a list of objects containing each registered telephone number of the individual, as listed:
\nResponse fields:
\nIt queries tax data for a Natural Person based on their CPF. If successful, the operation will return a taxReturns field containing a list of objects with the individual's tax information for each year, as listed:
\nResponse fields:
\nPerforms a query of lawsuits associated with a Natural Person based on their CPF. If the operation is successful, it will return a lawsuits field containing a list of objects with the lawsuits, as listed:
\nResponse fields:
\nnumber: Number of the lawsuit.
type: Type of lawsuit.
mainSubject: Subject assigned to the lawsuit.
courtName: Name of the court in which the case took place.
courtLevel: Level of the court.
courtType: Type of court.
courtDistrict: District of the court.\njudgingBody: Judging body of the court.\nstate: State where the the case took place.\nstatus: Status of the case.\nparties: Object list with information about each party involved in the case, including ID document, name, polarity (active, passive, neutral) and type (defendant, lawyer, etc).
Queries a Natural Person's profession using their CPF number. If the operation is successful, a profession field will be returned containing a list of objects with the individual's registered professions, as listed:
\nResponse fields:
\nPerforms a credit data query for a Natural Person based on their CPF.
\nResponse fields:
\nPerforms a query of a Natural Person's related phone data from their CPF. If successful, the operation will have a telephones field containing an object list with the information of each registered telephone number associated with the individual, as well as additional details.
\nResponse fields:
\nQueries financial risk data for a Natural Person based on their CPF number.
\nResponse fields:
\nPerforms a criminal record check for a Natural Person based on their CPF number. If successful, the query will return an additionalOutputData field containing the criminal record certificate issued by the Federal Police, as well as additional information.
\nResponse fields:
\nConsults the basic registration data for a Legal Person from their CNPJ.
\nResponse fields:
\nChecks the FGTS labor debt data of a Legal Person from its CNPJ.
\nResponse fields:
\nQueries data on first-level members associated with a CNPJ. If successful, the operation returns a firstLevelMembershipCircles field containing an object list with information about the first-level members, as follows:
\nResponse fields:
\nThis operation is responsible for validating the information regarding bettors. It applies to bettors who are barred from betting in order to ensure strict compliance with law 14.790/23, which establishes essential Know Your Customer (KYC) requirements for sports betting.
\nInput fields:
\nResponse fields:
\nFrom an individual's CPF, query their sports-related information, such as teams, championships and family members.
\nInput fields:
\nResponse fields:
\nOperation responsible for consulting politically exposed persons (PEP), sanctions and restrictions at national or international level. It also indicates whether the individual has a family relationship with a politically exposed person. The query is carried out using their CPF.
\nInput fields:
\nResponse fields:
\nThis API checks an individual's background for various scenarios. In general, its call consists of a body containing the individual's CPF (Individual Taxpayer Registration Number) or CNPJ (National Corporate Taxpayer Registration Number), as well as their internal id, while the response will vary according to the endpoint used, which will be based on the query you want to perform.
\nAlso, in the header of the request, you will need to enter your API key, which is assigned once you have hired the tool. The server's response to the call will depend on the endpoint used. The possible endpoints and their responses are documented below:
\n","_postman_id":"dc6de4c9-5d88-4f55-aca7-ffea07a0dfad"}]}