ASassinafy
Fields

Validate field value

Validate an input value against a field definition. Typically called with a signer access code during the signing flow.

Copy as Markdown Open in ChatGPT Open in Claude

post/v1/accounts/{accountId}/fields/{fieldId}/validate

Request

  • Base URL
    https://api.assinafy.com.br
  • URL
    https://api.assinafy.com.br/v1/accounts/{accountId}/fields/{fieldId}/validate
  • Auth
    • HTTP bearer
    • or API key in header X-Api-Key

Path parameters

accountIdstring required

Workspace account ID.

fieldIdstring required

The field ID.

Request body

valuestring required

The input value to validate.

Example request

{
  "value": "400.676.228-36"
}

Response

Validation result

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

{
  "status": 200,
  "data": {
    "type": "cpf",
    "success": true
  }
}

Changes

No recorded changes to this operation across all 15 revisions of this API.