Upload Document Entity

POST

https://dev-api.monoova.com/kyb/v1/UploadDocumentEntity

This endpoint allows you to upload entity documents directly via API. You may want to do this to fully customise the look and feel of the verification process within your website or application. Each call can only receive one document. Make sure to send the necessary data in the docSubType parameter.

Body Parameters

bodyUpload_Document_Entity

Example

{
  "applicantId": "4242424242424x424242424242424242",
  "docSubType": "Certificate of incorporation",
  "docFile": {
    "filename": "/path/to/your/file.pdf"
  }
}

applicantIdstringrequired
docSubTypestring
docFileobjectrequired
- filenamestring

Responses

200

Upload_Document_Entity_-_Response

Example

{
  "applicantId": "4242424242424x424242424242424242",
  "documentSubType": "Certificate of incorporation"
}

applicantIdstring
documentSubTypestring

400

curl

curl --request POST \
     --url https://dev-api.monoova.com/kyb/v1/UploadDocumentEntity \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "applicantId": "",
     "docFile": {}
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "applicantId": "",
   "docFile": {}
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://dev-api.monoova.com/kyb/v1/UploadDocumentEntity", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://dev-api.monoova.com/kyb/v1/UploadDocumentEntity")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "applicantId": "",
   "docFile": {}
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://dev-api.monoova.com/kyb/v1/UploadDocumentEntity"

payload = json.dumps({
   "applicantId": "",
   "docFile": {}
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

{
  "applicantId": "",
  "documentSubType": ""
}

400

This endpoint allows you to upload entity documents directly via API. You may want to do this to fully customise the look and feel of the verification process within your website or application.

Each call can only receive one document. Make sure to send the necessary data in the docSubType parameter.