Make consultation

Requests a report with financial information about an individual or company from Serasa Experian.

The report can use a customer already registered in Asaas through customer or the CPF/CNPJ provided directly in cpfCnpj. When using customer, the customer must have a registered CPF or CNPJ.

The report is processed at the time of the request. Set a timeout of at least 30 seconds for this operation.

⚠️

Report download

To retrieve the PDF after the report is requested, use the URL returned in downloadReport and make an authenticated GET request with a valid API key in the access_token header.

The URL returned in downloadReport uses the authenticated endpoint /api/v3/creditBureauReport/{id}/download.

📘

Enablement required

The account must be enabled to request Credit Bureau Reports via API. If the feature is not yet available, ask your Asaas account manager to enable it.

Requesting a report also sends the PDF to the email address registered in the Asaas account.

To later retrieve the data of a report by ID, use Retrieve a report.

To view the history, use List reports.

Related content

Guides

Body Params
string

Unique customer identifier in Asaas

string

CPF or CNPJ of the customer. Enter this field if your client is not registered with Asaas

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json