Know Your Customer
...
Global
Americas
Brazil CPF Fetch
overview the brazil cpf fetch api is designed to retrieve detailed information associated with a given cpf (cadastro de pessoas fÃsicas) number this api is tailored for use within brazil to help verify the identity and registration status of individuals, supporting compliance with local kyc regulations use case this api is crucial for a variety of business processes that require reliable identity verification in brazil, such as financial services verifying customer identity during account opening, loan applications, and other banking services e commerce confirming the identity of customers during checkout to prevent fraudulent transactions healthcare ensuring patient identity before providing medical services or access to medical records insurance verifying policyholder information during claims processing and new policy issuance employment background checks confirming the identity of potential hires to ensure they meet hiring criteria api details request body preproduction curl location 'https //api preproduction signzy app/api/v3/global kyc fetch/br/cpf' \\ \ header 'authorization < auth token >' \\ \ header 'content type application/json' \\ \ data raw '{ "cpf" "43335747810" }' production curl location 'https //api signzy app/api/v3/global kyc fetch/br/cpf' \\ \ header 'authorization < auth token >' \\ \ header 'content type application/json' \\ \ data raw '{ "cpf" "43335747810" }' request body parameters parameter type description required curp string the cpf number to fetch details for must be 8 to 11 characters long with only numbers allowed yes response body successful response { "result" { "cpfnumber" "433 357 410 99", "fullname" "tomaz geleuilzer", "dateofbirth" "1987 08 03", "registrationstatus" "regular", "isdeceased" false, "transactionresulttype" "success" } } data not found { "result" { "cpfnumber" "", "fullname" "", "dateofbirth" "", "registrationstatus" "", "isdeceased" "", "transactionresulttype" "invalidinputdata" } } response body parameters parameter type description cpfnumber string the cpf number formatted with dots and a dash fullname string the full legal name of the individual dateofbirth string the date of birth of the individual, formatted as yyyy mm dd registrationstatus string indicates the current status of the cpf (e g , "regular") isdeceased boolean indicates whether the individual is deceased transactionresulttype string the outcome of the api request typically "success" or an error description like "invalidinputdata" error code and response mapping 400 (bad request) { "error" { "name" "error", "message" "bad input and description ", "status" 400, "reason" "validation error", "type" "bad request", "statuscode" 400 } } \ { "error" { "name" "error", "message" "cpf must be at most 11 digit long ", "status" 400, "reason" "validation request", "type" "bad request", "statuscode" 400 } } \ { "error" { "name" "error", "message" "cpf must be at least 9 digit long ", "status" 400, "reason" "validation request", "type" "bad request", "statuscode" 400 } } \ { "error" { "name" "error", "message" "cpf must contain only numeric digits ", "status" 400, "reason" "validation request", "type" "bad request", "statuscode" 400 } } 401(unauthorized) { "error" { "name" "error", "message" "invalid authentication credentials", "status" 401, "reason" "authentication error", "type" "bad request", "statuscode" 401 } } 403 (forbidden) { "error" { "name" "error", "message" "forbidden", "reason" "error", "type" "bad request", "statuscode" "403" } } 500 (internal server error) { "error" { "name" "error", "message" "internal server error", "status" 500, "reason" "error", "type" "bad request", "statuscode" 500 } } 409(upstream down { "error" { "name" "error", "message" "upstream down", "status" 409, "reason" "error", "type" "bad request", "statuscode" 409 } } field type description name string text displayed on the screen explaining error type reason string reason for the error status number http status code message string error message indicating an upstream error type string error type statuscode number status code representing the error scenario getting help please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better you can reach out to us at help\@signzy com we strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively we value your feedback and are committed to making your experience smooth and enjoyable our team is dedicated to assisting you with any needs you may have thank you for choosing our services we look forward to helping you!