Resgata icon

Resgata

Integracao completa com a API Resgata para gestao de credito consignado

Cliente → Buscar Cliente

AI-generated

Summary

Search customers by CPF or phone number, returning matching customer data with pagination support.

Inputs

  • searchBy (required) — Choose whether to search by CPF (Brazilian individual taxpayer registry identification) or phone number.
  • searchValue (required) — Enter the CPF or phone number value to search for matching customers.
  • page — Specify the page number of the search results to retrieve; defaults to 1.
  • limit — Set the maximum number of results returned per page; defaults to 50.

Output shape

a list of customer records matching the search criteria, including pagination information when available

Returned data includes a 'data' array of customer objects, and optionally a '_pagination' object with pagination details. If no customers are found, an empty data array is returned.

Discussion