Validation CPF

Valide un numero de CPF en verifiant le format et les chiffres de controle via l'algorithme Modulo 11.

Endpoint

POST /api/external/cpf/validate

En-tetes

En-tete	Type	Obligatoire	Description
Authorization	String	Oui	ApiKey {client_id}:{client_secret}
Content-Type	String	Oui	application/json

Corps de la requete

Champ	Type	Obligatoire	Description	Exemple
document_number	String	Oui	Numero du CPF (avec ou sans formatage)	"12345678909" ou "123.456.789-09"

Exemple

curl -X POST https://api.owem.com.br/api/external/cpf/validate \
  -H "Authorization: ApiKey $CLIENT_ID:$CLIENT_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"document_number":"12345678909"}'

Reponse de succes -- CPF valide (200)

{
  "worked": true,
  "valid": true,
  "formatted": "123.456.789-09"
}

Reponse de succes -- CPF invalide (200)

{
  "worked": true,
  "valid": false,
  "formatted": null
}

Champ	Type	Description
worked	Boolean	true indique que la requete a ete traitee
valid	Boolean	true si le CPF est valide, false dans le cas contraire
formatted	String	CPF formate (XXX.XXX.XXX-XX) si valide, null si invalide

Validations effectuees

1. Verifie que le CPF comporte exactement 11 chiffres
2. Rejette les CPF dont tous les chiffres sont identiques (ex : 111.111.111-11)
3. Calcule et verifie les 2 chiffres de controle via l'algorithme Modulo 11

Reponse d'erreur (400)

{
  "worked": false,
  "detail": "O campo document_number e obrigatorio"
}

Reponse d'erreur (401)

{
  "error": {
    "status": 401,
    "message": "Missing API key credentials. Use Authorization: ApiKey <client_id>:<client_secret>"
  }
}

Utilisation

Cet endpoint effectue uniquement une validation mathematique du CPF (Modulo 11). Il ne consulte pas la Receita Federal et ne verifie pas la situation cadastrale du document.