Many thanks for your interest in integrating with Veriphy.

 

Our API Web Services allow integrators simple access to an array of different data services offered by multiple third party suppliers.

 

Attached is an overview document which lists all these services.

The online information available via the link below gives you everything you need to start testing. Once your test integration is successfully running, please request access to our live service.

It is assumed that you are familiar with Web Services and concepts such as SOAP, XML and hierarchical data structures.

 

 

 

 

The Veriphy test server can be found at: https://test.veriphy.co.uk/

 

The API docs are available here: https://test.veriphy.co.uk/api - this is also the API endpoint for your requests.

 

The online documentation covers both IDAML and Company checks – Lawyer Checks to follow shortly. Using the documentation website developers can explore the API, examine the request/responses from the different operations and actually interact directly with the API firing off requests.

 

For example;

 

1)      Click on the IDAML POST method to perform an IDAML check

2)      Scroll down to review the implementation notes and the sample response model. Note that we can accept requests/produce responses in either XML or JSON now.

3)      In the parameters section on the right hand side you’ll see an Example JSON request. Click on the yellow box and the values will be added to the white left hand “check” value box.

4)      Click the “Try it out!” button – the request is fired at the API. Scroll down to view the response

5)      You’ll see that an error (http 400) is returned – check out the Response body – validation is built in to the API telling the developer what is wrong with the request. In this case we have not supplied credentials.

6)      In the white check value box scroll down to the authenticationTO and add the test account credentials so it looks like this:

 

"authenticationTO": {

    "password": "GUNIT_PASSWORD",

    "username": "TEST_ACCOUNT"

  },

7)      Click the “Try it out!” button again – this time the request will work and the Response Body will contain the results in JSON format. The normal check result PDF is also included in this response alongside the raw data.

8)      Validation covers all aspects of the request – so, for example if an integrator sends over an invalid Travel Visa we apply the same validation/information as on the website:

 

Find attached a very simple generated client for the API in C# that fires off an IDAML check and produces a PDF report.

 

To get a head start you can generate sample client code to use as a starting point for your integration. Visit http://editor.swagger.io/ and simply import the URL https://test.veriphy.co.uk/api/docs/v1. You will then be able to generate a client using C#, VB, Java, PHP, Ruby, Python and many other languages.

 

Thank you again for choosing Veriphy. If you have any queries please do not hesitate to get in touch via support@veriphy.co.uk