Documentação Técnica

Códigos e Descrições de Status

O retorno da consulta, além dos dados requisitados, inclui também uma lista de status da consulta por dataset. Cada status está associado a um código de retorno ou situação identificada durante a consulta. Os códigos que vão de -100 a -999 estão no geral relacionados aos dados de entrada. Vale ressaltar que os status aqui apresentados são passíveis de cobrança ou não a depender do dataset consultado, para maiores informações verifique a documentação específica de cada dataset que pretende consultar.

StatusMensagem
-100USER IS NOT ENABLED TO QUERY DATAPLATFORM API. TO ENABLE THIS SERVICE, CONTACT OUR SUPPORT TEAM
-101DATAPLATFORM USER HAS EXPIRED. TO CREATE A NEW USER, CONTACT OUR SUPPORT TEAM
-102INVALID Q PARAMETER. PLEASE CHECK THE DOCUMENTATION FOR THIS DATASET
-103THERE IS NO DATAPLATFORM API ENABLED FOR THIS USER. TO ENABLE THIS SERVICE, CONTACT OUR SUPPORT TEAM
-104USER DOESN'T HAVE PERMISSION TO QUERY PEOPLE API. TO ENABLE THIS SERVICE, CONTACT OUR SUPPORT TEAM
-105USER DOESN'T HAVE PERMISSION TO QUERY COMPANIES API. TO ENABLE THIS SERVICE, CONTACT OUR SUPPORT TEAM
-106USER DOESN'T HAVE PERMISSION TO QUERY VALIDATIONS API. TO ENABLE THIS SERVICE, CONTACT OUR SUPPORT TEAM
-107USER DOESN'T HAVE PERMISSION TO QUERY CUSTOM API. TO ENABLE THIS SERVICE, CONTACT OUR SUPPORT TEAM
-108USER DOESN'T HAVE PERMISSION TO QUERY MISC API. TO ENABLE THIS SERVICE, CONTACT OUR SUPPORT TEAM
-109DATASET NOT AVAILABLE. CHECK THAT THE DATASET NAME IS CORRECT AND REQUEST THE DOMAIN ADMINISTRATOR TO ENABLE IT IN BDC CENTER
-110DATASET DOES NOT EXIST. MAKE SURE YOU ENTER THE CORRECT DATASET NAME
-111INVALID ACCESS TOKEN. MAKE SURE TO ENTER THE CORRECT ACCESS TOKEN IN THE REQUEST HEADER
-112ACCESS TOKEN NOT FOUND. MAKE SURE TO ENTER THE ACCESS TOKEN IN THE REQUEST HEADER
-113INVALID VIEW PARAMETER. MAKE SURE TO INPUT A EXISTING VIEW FOR YOUR USER
-114INVALID DOC PARAMETER
-115INVALID DATE. PLEASE CHECK DATE_FORMAT PARAMETER
-116THIS VIEW ALREADY EXISTS. CHANGE VIEW NAME AND TRY AGAIN
-118EMAIL PARAMETER MUST BE FILLED OUT
-119NOT FOUND IN CACHE
-120SPECIFIED LOCALE IS NOT SUPPORTED
-121PHONE PARAMETER MUST BE FILLED OUT
-122NAME PARAMETER MUST BE FILLED OUT
-123BIRTH DATE PARAMETER MUST BE FILLED OUT
-124VIEW NOT FOUND. MAKE SURE TO INPUT A EXISTING VIEW FOR YOUR USER
-125INVALID DATASET SYNTAX. PLEASE CHECK THE DOCUMENTATION FOR THIS DATASET
-126INVALID Q SYNTAX. PLEASE SEE HOW TO QUERY THE DATAPLATFORM IN OUR DOCUMENTATION
-127VIEW IS NOT ENABLED FOR THIS API. PLEASE CREATE A NEW ONE FOR THE DESIRED API
-128YOU HAVE REACHED THE QUERY LIMIT FOR THIS DATASET. IF YOU NEED TO MAKE MORE QUERIES, REQUEST THE DOMAIN ADMIN TO INCREASE THE LIMIT
-129THE IP ADDRESS USED FOR THIS REQUEST IS NOT ENABLED FOR THIS USER.
-130THE PARAMETERS USED RETURNED TOO MANY RESULTS. TRY ADDING OTHER FIELDS AS DISCRIBED IN OUR DOCUMENTATION
-131INVALID API PARAMETER. PLEASE CHECK THE DOCUMENTATION FOR THIS API
-132INVALID HOOKS PARAMETER. PLEASE CHECK HOW TO USE THIS API IN OUR DOCUMENTATION
-133UNRESPONSIVE HOOKS ENDPOINT
-134UNABLE TO PARSE DATE FIELD(S): PLEASE, SPECIFY THE CORRECT DATEFORMAT
-135USER DOESN'T HAVE PERMISSION TO QUERY PRODUCTS API. TO ENABLE THIS SERVICE, CONTACT OUR SUPPORT TEAM
-136USER DOESN'T HAVE PERMISSION TO QUERY INVOICES API. TO ENABLE THIS SERVICE, CONTACT OUR SUPPORT TEAM
-137INVALID INVOICE PARAMETER
-138INVALID ORDER PARAMETERS. PLEASE CHECK THAT PROPERTY NAME AND DIRECTION ARE CORRECT.
-139UF PARAMETER MUST BE FILLED OUT
-140RG PARAMETER MUST BE FILLED OUT
-141USER DOESN'T HAVE PERMISSION TO QUERY RECEIPTS API. TO ENABLE THIS SERVICE, CONTACT OUR SUPPORT TEAM
-142INVALID RECEIPT PARAMETER
-143INVALID PAGINATION PARAMETER
-144USER DOESN'T HAVE PERMISSION TO QUERY VEHICLES API. TO ENABLE THIS SERVICE, CONTACT OUR SUPPORT TEAM
-145INVALID VEHICLES PARAMETER
-146INVALID AGE FILTER PARAMETER
-147USER DOESN'T HAVE PERMISSION TO QUERY LAWSUITS API. TO ENABLE THIS SERVICE, CONTACT OUR SUPPORT TEAM
-148INVALID LAWSUITS PARAMETER
-149UNABLE TO LOAD FILE, PLEASE CHECK URI AND TRY AGAIN.
-150INVALID REQUEST_ID PARAMETER.
-151INVALID ENTITIES PARAMETER
-152INVALID CROQUI PARAMETER
-153INVALID LOCATIONS PARAMETER
-154INVALID NIRFS PARAMETER
-155INVALID CAR NUMBER PARAMETER
-156INVALID FILESGLEBES PARAMETER
-157TOO BIG POLYGON RADIUS. THE POLYGONS MUST HAVE RADIUS MINOR THAN 100 KM.
-158USER DOESN'T HAVE PERMISSION TO QUERY ADDRESSES API. TO ENABLE THIS SERVICE, CONTACT OUR SUPPORT TEAM
-159USER EXCEEDED MAXIMUM ENTITIES LIMIT IN THE SAME REQUEST
-160INVALID REQUEST BODY. PLEASE, ENSURE THAT THE OBJECT SENT IS IN THE APPROPRIATE FORMAT.
-161INVALID TAG SYNTAX. MAKE SURE ALL INPUT TAGS FOLLOW OUR PREDEFINED CRITERIA.
-162TAGS LIMIT EXCEEDED. MAXIMUM 10 TAGS CAN BE SENT PER REQUEST.
-163INVALID TAG SIZE. EACH KEY AND VALUE MUST BE BETWEEN 1 AND 255 CHARACTERS.
-164INVALID TAG KEY. PLEASE USE ONLY ASCII LETTERS OR UNDERLINES.
-165INVALID TAG VALUE. PLEASE USE ONLY LETTERS, NUMBERS, AND ALLOWED SPECIAL CHARACTERS.
-166INVALID QLIST PARAMETER. PLEASE SEE HOW TO QUERY THE DATAPLATFORM IN OUR DOCUMENTATION
-167INVALID TIMEOUT PARAMETER. PLEASE, CHECK OUR DOCUMENTATION FOR MORE INFORMATION
-168INVALID SESSION ID. PLEASE, GENERATE A NEW SESSION ID AND TRY AGAIN.
-200THIS CPF BELONGS TO A MINOR. DATE OF BIRTH IS NEEDED TO PROCESS REQUEST.
-201THIS CPF BELONGS TO A 12 YEAR OLD OR LESS. REQUEST CAN'T BE PROCESSED FOR LEGAL REASONS.
-202DATE OF BIRTH DOESN'T MATCH CPF. CORRECT DATE OF BIRTH IS NEEDED TO PROCESS REQUEST.

Os códigos que vão de -1000 até -1199 estão relacionados à problemas de login:

StatusMensagem
-1000ACCESS TOKEN IS NOT LINKED WITH DATAPLATFORM ACCOUNT
-1001UNABLE TO OPEN USER SESSION. IF THIS ERROR PERSISTS, PLEASE CONTACT OUR SUPPORT TEAM
-1002UNABLE TO LOAD DATAPLATFORM METADATA. IF THIS ERROR PERSISTS, PLEASE CONTACT OUR SUPPORT TEAM
-1003ACCESS TOKEN HAS EXPIRED. GENERATE A NEW ONE USING THE BDC CENTER
-1004USER GROUP IS DEACTIVATED. IF THIS IS NOT EXPECTED, CONTACT OUR SUPPORT TEAM

Os códigos que que vão de -1200 até -1999 estão relacionados à problemas internos nas APIs ou nos datasets:

StatusMensagem
-1200UNEXPECTED ERROR. PLEASE CONTACT OUR SUPPORT TEAM
-1201DATASET IS TOO SLOW. PLEASE TRY AGAIN IN A FEW MINUTES
-1202INVALID DATASOURCE CREDENTIALS. PLEASE CONTACT OUR SUPPORT TEAM
-1203DATASET DISABLED TEMPORARILY
-1204UNABLE TO CREATE VIEW. PLEASE CONTACT OUR SUPPORT TEAM
-1205CATALOG NOT FOUND. IF THIS ERROR PERSISTS, PLEASE CONTACT OUR SUPPORT TEAM
-1206CONTRACT NOT FOUND. IF THIS ERROR PERSISTS, PLEASE CONTACT OUR SUPPORT TEAM
-1207UNABLE TO LOAD QUERY LIMIT FOR THIS DATASET. IF THIS ERROR PERSISTS, PLEASE CONTACT OUR SUPPORT TEAM
-1208UNABLE TO UPDATE QUERY LIMIT FOR THIS DATASET. IF THIS ERROR PERSISTS, PLEASE CONTACT OUR SUPPORT TEAM
-1209COULD NOT FIND A NAME FOR THIS DOCUMENT NUMBER
-1210UNABLE TO AGGREGATE PASSAGES IN TIME
-1211UNABLE TO LOAD CONTRACT. IF THIS ERROR PERSISTS, PLEASE CONTACT OUR SUPPORT TEAM
-1212TIMEOUT EXCEEDED FOR THIS QUERY. IF THIS ERROR PERSISTS, PLEASE CONTACT OUR SUPPORT TEAM
-1213UNABLE TO CONNECT TO PARTNER RESOURCE. IF THIS ERROR PERSISTS, PLEASE CONTACT OUR SUPPORT TEAM
-1214YOU ARE MAKING TOO MANY REQUESTS. PLEASE IMPLEMENT A RATE-LIMIT TO AVOID RECEIVING ERRORS.
-1215UNABLE TO AGGREGATE DATA IN TIME.
-1399SOURCE PARAMETER MUST BE FILLED OUT

Os códigos que que vão de -2000 a -2999 estão relacionados às consultas on-demand:

StatusMensagem
-2000UNABLE TO FIND NEURAL NETWORK FILES TO RECOGNIZE CAPTCHAS
-2001UNABLE TO RECOGNIZE CAPTCHA
-2002UNABLE TO PROCESS CAPTCHA IMAGE
-2003WEBSITE REDIRECTED TO AN UNKNOWN PAGE
-2004UNABLE TO DOWNLOAD CAPTCHA IMAGE
-2005UNABLE TO PARSE DATA
-2006UNABLE TO FIND PIS NUMBER
-2007STATE QUERY NOT IMPLEMENTED. PLEASE ENTER ONLY QUERIES FOR THE AVAILABLE STATES AS DESCRIBED IN THE DATASET DOCUMENTATION
-2008NOT ENOUGH DATA TO GENERATE OUTPUT. WE DO NOT HAVE ENOUGH INFORMATION TO FILL IN THE RESULT BASED ON THE INPUT PROVIDED
-2009SOURCE QUERY NOT IMPLEMENTED
-2010SOURCE IS NOT RESPONDING. PLEASE TRY AGAIN LATER
-2011CNPJ INACTIVE OR IN BANKRUPTCY

Os códigos que que vão de -3000 em diante estão relacionados a problemas na API de Monitoramento ou de Chamadas Assíncronas:

StatusMensagem
-3000QUERY ID DOESN'T BELONG TO THIS CLIENT GROUP
-3001QUERY ID DOESN'T EXIST
-3002RECEIVED CURSOR IS NOT VALID
-3003INVALID SUBSCRIPTION URL
-3004SUBSCRIPTION ID NOT FOUND
-3005UNABLE TO SUBSCRIBE. RESULTS MUST RETURN SUCCESS STATUS.
-3006UNABLE TO SUBSCRIBE. A SUBSCRIPTION WITH THIS DATA ALREADY EXISTS.
-3007UNABLE TO SUBSCRIBE. RECEIVED AN INVALID QUERY TYPE.
-3008HOOK REQUEST QUEUED, PENDING DISPATCHMENT.
-3009HOOK REQUEST DISPATCHED, PENDING FULFILMMENT.
-3010SUBSCRIPTION IS ALREADY DISABLED.
-3011SUBSCRIPTION USER NOT FOUND IN DATABASE.
-3012THE RESULT IS TOO LARGE. PLEASE USE FILTERS OR FIELD SELECTION TO REDUCE THE RESPONSE SIZE.
-3013MULTIPLE HOOK PARAMETERS. ONLY ONE TYPE OF HOOKS SHOULD BE USED, AS DESCRIBED IN OUR DOCUMENTATION.
-3014SOME OF THE REQUESTED DATASETS ARE NOT SUBSCRIBABLE. SEE THE FULL LIST OF ALLOWED DATASETS IN OUR DOCUMENTATION.
-3015YOUR SUBSCRIPTION LIMIT HAS BEEN REACHED. IF YOU WANT TO INCREASE YOUR LIMIT, PLEASE CONTACT OUR SUPPORT TEAM.
-3016THE BATCH SUBSCRIBE METHOD IS NOT ENABLED FOR YOUR USER. IF YOU WANT TO ENABLE IT, PLEASE CONTACT OUR SUPPORT TEAM.
-3017THE REQUESTED BATCH SUBSCRIPTION ID WAS NOT FOUND.
-3018INVALID INPUT FILE. PLEASE ENSURE THAT THE FILE MEETS THE CRITERIA DESCRIBED IN OUR DOCUMENTATION.