Data Matching API

Many businesses and organizations face issues with data quality and data consistency during data entry by the users in the onboarding processes. These issues cause significant operational overheads as well as frustration from the customers as it significantly extends onboarding timings with multiple back-and-force loops. This is a time-consuming and error-prone process, especially when dealing with paper documents or unstructured data. The /matching API aims to automate this process by allowing users to check if the data captured by the user exists in the document where it is expected to exist therefore ensuring that if there is an error (either the data is not captured correctly or wrong document is provided) user can be notified straight away and such an error can be fixed without additional time consuming actions on either side (e.g. customer or organization).

Our service will perform OCR of the document using Uqudo AI models will perform required validations.

post

Matching API

Header parameters

UQ-Session-IDstringOptional

AuthorizationstringRequired

Bearer token

Body

application/json

documentstringRequired

Base64 encoded file. JPEG, PNG and PDFs are allowed. Max file size allowed 3MB. In case of a PDF only the first 3 pages are taken into consideration

documentTypestring · enumRequiredPossible values:

Responses

200

Matching result

application/json

400

Bad Request: Missing required input or invalid format

application/json

401

Unauthorized: No valid access token has been provided

403

Forbidden: Access token doesn't have permission to use the requested feature

405

Method Not Allowed

413

Content Too Large

application/json

415

Unsupported Media Type

500

Internal Server Error: Unexpected error

post

/v1/matching

HTTPcURLJavaScriptPython

POST /api/v1/matching HTTP/1.1
Host: kyb.uqudo.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 169

{
  "document": "text",
  "documentType": "BUSINESS_LICENSE",
  "fields": [
    {
      "fieldId": "text",
      "fieldValue": "text",
      "ignoreSeparator": false,
      "caseInsensitive": false,
      "dateField": false
    }
  ]
}

{
  "fields": [
    {
      "fieldId": "text",
      "match": true
    }
  ]
}

You can find the full YAML swagger specification here

4KB

kyb_data_matching.yml

Open

You can find the full JSON swagger specification here

12KB

kyb_data_matching.json

Open