Headers


When making calls to the API, there are 3 headers that the system will process.

  1. Ocp-Apim-Subscription-Key
  2. VerifleUserId
  3. VerifileSubsidiaryOrganisationId

Ocp-Apim-Subscription-Key

When making a call to any of the Verifile API endpoints, an Ocp-Apim-Subscription-Key is always mandatory. This value can be found in the profile section of the API management portal.

This is the key that identifies to Verifile who is making the call. Hence there is a need to keep this value secure. Should the key become compromised then you can use the API management portal to regenerate the key at any time.

We provide 2 keys, primary and secondary, and both are valid when submitting calls to Verifile. This allows the continuation of service while a key is being regenerated. Both keys are treated equally with no processing preference to either key.

VerifileUserId

When calling the API methods that raise new orders, you need to add a HTTP request header VerifileUserId.

The VerifileUserId indicates which Verifile user account is creating the order and who Verifile should communicate with if any queries come up during the order processing.

The owners of these accounts have the ability to log into the Verifile Web Application to see these orders and track their progress. These accounts are tied to an email address so we can communicate with the user directly.

Currently you can email api@verifile.co.uk to setup new accounts and see which accounts are available.

VerifileSubsidiaryOrganisationId

Verifile system has the ability to handle a multiple companies in a organised in a hierarchal fashion, so that an API can create an order to help reflect your company’s structure. When raising a new order, the order is placed under the company that the user in VerifileUserId is linked to.

Should there be a need to place an order against a subsidiary company of VerifileUserId, then by setting a VerifileSubsidiaryOrganisationId header, you can ensure that the order is created against that particular company.

A company can’t be a subsidiary of the VerifileUserId. Also, the VerifileUserId might be for a user who is at the same level of the organisation the order is placed on behalf of.

Below is a table detailing an example of 4 companies linked together and what would happen if orders were placed at different levels.

VerifileUserId VerifileSubsidiaryOrganisationId
  • Company A
    • Company B - User B
      • Company D
    • Company C
  • Company A
    • Company B
      • Company D
    • Company C
Yes. Order created for Company D for user B.
  • Company A
    • Company B
      • Company D - User D
    • Company C
  • Company A
    • Company B
      • Company D
    • Company C
No. User not allowed create order for company above them in hierarchy.
  • Company A
    • Company B - User B
      • Company D
    • Company C
  • Company A
    • Company B
      • Company D
    • Company C
No. User not allowed create order for company at the same level in the hierarchy.
  • Company A - User A
    • Company B
      • Company D
    • Company C
  • Company A
    • Company B
      • Company D
    • Company C
Yes. Order created for Company D for user A.
  • Company A
    • Company B
      • Company D
    • Company C - User C
  • Company A
    • Company B
      • Company D
    • Company C
No. User not allowed create order for company which isn’t part of the hierarchy.
  • Company A
    • Company B - User B
      • Company D
    • Company C
  • Company A
    • Company B
      • Company D
    • Company C
Yes. Order created for Company B for User B.

Again, you can email api@verifile.co.uk to see which accounts are available.