Retrieve Partner Client PF by Document

Route to retrieve a list of PF client partners by CPF

The customer search route is essential in a customer management system, allowing users to search and obtain information about specific customers based on different search criteria. This route is useful for retrieving existing customer data and performing operations such as viewing, updating.

Response parameters

ParametersFormatDescription
codeStringIdentification code
created_atStringClient created at
nameStringClient name
documentStringClient document
genderStringClient gender
mother_nameStringClient mother name
birthdayStringClient birth date
identity_numberStringClient identity number
phone_numberStringClient phone number
emailStringClient Email
nationalityStringClient nationality
addressObjectClient address
zip_codeStringClient zip code
streetStringClient street
numberStringClient number
complementStringClient complement
neighborhoodStringClient neighborhood
cityStringClient city
ufStringClient state
banking_dataArrayData Banking Account
codeStringIdentification Code Bank Account
created_atStringCreated at bank Account
bankStringBank code bank account
agencyStringAgency code bank account
accountStringAccount code bank account
digitStringDigit code bank account
code_status_digital_accountStringDigital account status code
status_digital_accountStringDigital account status
code_status_userStringUser status code
status_userStringUser status

User Status

IdentificationDescription
1in_analysis
3reproved
5blocked
7approved
9blocked_judge

Digital account status

IdentificationDescription
1active
2denied
3closed

Request parameters

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here!