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.

Matching API

post

/v1/matching

Header parameters

UQ-Session-IDstring

Authorizationstringrequired

Bearer token

Body

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 · enumrequired

Options: BUSINESS_LICENSE, TAX_CERTIFICATE, SHAREHOLDERS_REGISTER, MEMORANDUM_OF_ASSOCIATION, ARTICLES_OF_ASSOCIATION, CERTIFICATE_OF_INCORPORATION, ESTABLISHMENT_CARD, ADDRESS_VERIFICATION_DOCUMENT, OTHER_BUSINESS_REGISTRATION_DOCUMENT, BALANCE_SHEET, PROFIT_AND_LOSS, CASH_FLOW_STATEMENT, OTHER_FINANCIAL_DOCUMENT, OTHER

fieldsobject[]required

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://kyb.uqudo.io/api/v1/matching' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "document": "text",
    "documentType": "BUSINESS_LICENSE",
    "fields": [
      {
        "fieldId": "text",
        "fieldValue": "text",
        "ignoreSeparator": false,
        "caseInsensitive": false,
        "dateField": false
      }
    ]
  }'

200

400

401

403

405

413

415

500

200

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

Matching result

You can find the full YAML swagger specification here

4KB

kyb_data_matching.yml

You can find the full JSON swagger specification here

12KB

kyb_data_matching.json