POST
/
v3
/
validation_results
Create a validation result
curl --request POST \
  --url https://{region}.affinda.com/v3/validation_results \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "annotations": [
    1,
    2,
    3
  ],
  "passed": true,
  "ruleSlug": "supplier-name-is-alphanumeric",
  "message": "Expected '\''ThisInputShouldMatch'\'' to match regex pattern '\''[0-9]*",
  "document": "<string>"
}'
{
  "id": 1,
  "annotations": [
    1,
    2,
    3
  ],
  "passed": true,
  "ruleSlug": "supplier-name-is-alphanumeric",
  "message": "Expected 'ThisInputShouldMatch' to match regex pattern '[0-9]*",
  "document": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Body

application/json
​
annotations
integer[]
required

List of annotation ids that were validated

Example:
[1, 2, 3]
​
ruleSlug
string
required

The kebab-case slug of the validation rule that was applied

Example:

"supplier-name-is-alphanumeric"

​
message
string
required

Message explaining why the validation failed

Example:

"Expected 'ThisInputShouldMatch' to match regex pattern '[0-9]*"

​
document
string
required

Unique identifier for the document

​
passed
boolean | null

Whether the validation passed or not, null if the validation was not applicable

Example:

true

Response

Successfully created a validation result.

Validation result arising from a ValidationRule

​
id
integer
required

Validation Result's ID

Required range: x >= 1
Example:

1

​
annotations
integer[]
required

List of annotation ids that were validated

Example:
[1, 2, 3]
​
passed
boolean | null
required

Whether the validation passed or not, null if the validation was not applicable

Example:

true

​
ruleSlug
string
required

The kebab-case slug of the validation rule that was applied

Example:

"supplier-name-is-alphanumeric"

​
message
string
required

Message explaining why the validation failed

Example:

"Expected 'ThisInputShouldMatch' to match regex pattern '[0-9]*"

​
document
string
required

Unique identifier for the document