KYC API Documentation
  1. v1-product
KYC API Documentation
  • v1-company
    • Retrieves announcement data
      GET
    • Retrieves a list of stock exchange listings
      POST
    • Retrieves a list of companies
      GET
    • Retrieves a list of companies from the official business register
      GET
    • Retrieves a list of companies from the official business register
      GET
    • Get available ChangeTypes
      GET
    • Retrieves a list of registered monitors
      GET
    • Get monitor status for specific company id
      GET
    • Register a Company for monitoring
      POST
    • Deactivates an active notification
      POST
    • Retrieves a list of registered notifications
      GET
    • Retrieves a list of registered notifications
      GET
    • Creates a new notification
      POST
    • Unregister a company from Monitoring
      POST
    • Retrieves a list of companies from the KYC API company index
      GET
    • Retrieves a list of companies from the KYC API company index
      GET
    • Retrieves a list of companies from the KYC API company index
      POST
    • Retrieves company announcements
      GET
    • Retrieves structured data extracted from a company document
      GET
    • Retrieves company details
      GET
  • v1-ein-verification
    • Verifies an EIN number
    • Verifies EIN number and retrieves company data
    • Retrieves a list of EIN numbers
  • v1-iban-verification
    • Checks validity of an IBAN number
    • Checks validity of an IBAN number
  • v1-nif-verification
    • Verifies a NIF number
    • Verifies a NIF number and retrieves company data
  • v1-pepsanction
    • Retrieves a list of monitor entries
    • Deactive a pep sanction monitor
    • Update details of active Pep Sanction monitor
    • Orders a new Pep Sanction Check Report
    • Returns a json or pdf report
  • v1-product
    • Retrieves a document availability result
      GET
    • Returns a catalog of products
      GET
    • Returns metadata for a notifier
      GET
    • Creates a notifier for an order
      POST
    • Places a concierge order
      POST
    • Places a UBO order
      POST
    • Places a product order
      POST
    • Places a product order
      POST
    • Returns a list of products
      GET
    • Returns metadata for a order
      GET
    • Updates metadata of an order
      POST
    • Retrieves the result of an order
      GET
  • v1-system
    • Returns a list of countries
    • Returns the health information for the official business registers based on usage.
    • Returns a list of products with prices
  • v1-tin-verification
    • Verifies a TIN number
    • EIN Name Lookup with TIN number and retrieves company data
    • EIN Name Lookup with TIN number
  • v1-vat-verification
    • Returns a verification result
    • Returns a verification result and company data
    • Returns a level two verification result
    • Returns a list of vat numbers with additional data
  1. v1-product

Updates metadata of an order

POST
/api/v1/product/update/{action}/{orderId}
v1-product
Update an existing order identified by its order id
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.kompany.com//api/v1/product/update//'
Response Response Example
200 - Example 1
{}

Request

Path Params
action
string 
required
The action you want to perform for the order
orderId
string 
required
ID of the ProductOrder as returned from a /product/buy call - 32 character hex value
Body Params application/x-www-form-urlencoded
credits
number 
optional
Specify an amount of credits which should be added to the order
Example:
100

Responses

🟢200Success
application/json
Body
object {0}
🔴500500
Previous
Returns metadata for a order
Next
Retrieves the result of an order
Built with