Document

Submit a document

POST https://biometrid.com/api/providers/:stepId/document?processId=:processId

This endpoint allows you to submit a document for validation.

Path Parameters

Name	Type	Description
stepId	string	ID of the step to get

Query Parameters

Name	Type	Description
processId	string	ID of the process, to save the response

Headers

Name	Type	Description
Accept-Language	string	en (default), pt
Content-Type	string	application/json
Authentication	string	Authentication account token

Request Body

Name	Type	Description
front	string	Base64 string
back	string	Base64 string
doctype	string	idcard, passport

200

{
  "data": {
    "fields": {
      "surnames": "string",
      "names": "string",
      "gender": "string",
      "height": "string",
      "origin": "string",
      "birth_date": "string",
      "id_number": "string",
      "doc_number": "string",
      "expiry_date": "string",
      "parents": "string",
      "tax_number": "string",
      "social_security_number": "string",
      "health_number": "string",
      "mrz": {
        "line0": "string",
        "line1": "string",
        "line2": "string"
      },
      "nationality": "string",
      "model": "string"
    },
    "images": {
      "front": "string",
      "back": "string",
      "signature": "string",
      "photo": "string"
    },
    "result": "string",
    "validations": {
      "element_front_country": "string",
      "element_front_title": "string",
      "element_front_chip": "string",
      "element_front_dovid": "string",
      "element_front_mli": "string",
      "element_front_coat_arms": "string",
      "element_front_quina": "string",
      "element_back_filet": "string",
      "element_back_title": "string",
      "element_back_armillary": "string",
      "element_back_european": "string",
      "element_back_text": "string",
      "fake_front_value": "string",
      "fake_back_value": "string",
      "fake_front_ratio": 1,
      "fake_back_ratio": 1,
      "front_quality_ratio": 38.7,
      "front_quality_value": "string",
      "front_brightness": "string",
      "front_blurring": "string",
      "back_quality_ratio": 45.23,
      "back_quality_value": "string",
      "back_brightness": "string",
      "back_blurring": "string",
      "integrity_id_number": "string",
      "integrity_doc_number": "string",
      "expiration_date": "string",
      "match_doc_number": "string",
      "integrity_tax_number": "string",
      "integrity_birth_date": "string",
      "integrity_expiry_date": "string",
      "match_birth_date": "string",
      "match_name": "string",
      "match_surname": "string",
      "match_gender": "string",
      "match_id_number": "string",
      "match_nationality": "string",
      "match_expiry_date": "string",
      "score": 100,
      "value": "string"
    },
    "process": "string",
    "message": "string"
  },
  "meta": {
    "message": "Success."
  },
  "status": true
}

400

{
  "data": {},
  "meta": {
    "message": "Invalid action type",
    "code": "BIOSSGA002"
  },
  "status": false
}

{
  "data": {},
  "meta": {
    "message": "Required provider field",
    "code": "BIOPGVL009"
  },
  "status": false
}

404

{
  "data": {},
  "meta": {
    "message": "Step not found",
    "code": "BIOSSGB001"
  },
  "status": false
}