OCocrolus
Business Verification (Deprecated)

Create business verification (Deprecated)

Create a new business for verification and due diligence.

Once created, we will automatically begin verifying the legitimacy of the business.

We have partnered with Middesk to bring you this data. To use this endpoint, please follow the following steps:

  1. Sign up for an account with Middesk.
  2. Get your Middesk production API key (we don't support sandbox accounts at the moment).
  3. Call our Vendor Auth with middesk as the vendor name and put the API key in the request body.
  4. Set up an Ocrolus webhook by calling Configure Webhook to get back the Middesk results as soon as they are done processing.
  5. Call this endpoint with the uuid for a Book containing one of your business loan applicants to get the verification process started.
  • Make sure the Book is verified before making the call.
  1. Get the results back in a timely way with the webhook you set up earlier!
  2. Or you can also call the Retrieve business verification endpoint with the book_uuid and business_uuid in case you prefer to get back the results this way.
post/v2/book/{book_uuid}/business

Request

  • Base URL
    https://api.ocrolus.com
  • URL
    https://api.ocrolus.com/v2/book/{book_uuid}/business
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.ocrolus.com/oauth/token

Path parameters

book_uuidstring uuid required

The unique identifier of the <glossary:Book> that contains the <glossary:Document>s associated with the newly-created business.

Query parameters

namestring

The legal name of the business.

addressesobject[]

One or more addresses from which the business operates.

websitestring

The URL of the business' public-facing website.

Response

Success

book_uuidstring

A universal unique identification code for a <glossary:Book>.

business_uuidstring

A universal unique identification code for a business.

middesk_responseobject

An object potentially containg information from Middesk.

Example response

{
  "book_uuid": "c383ac62-61b8-43eb-a71f-88c8037ad681",
  "business_uuid": "950335c1-1c55-432a-8be7-2961a03d0b5b"
}

Changes

No recorded changes to this operation across all 1 revision of this API.