Integrating BridgeApps PIN API

Details to empower you to integrate your System with PIN API.

Audience

This page is expected to be read by a Technical Audience - Developers, Designers, Architects, CTOs

Swagger API

API Client codebase

We did start to write this client codebase for different Programming languages. However, this is apparently no longer relevant. Simply go to any LLM based chat engine, and generate the Client code from the OpenAPI spec - downloadable from Swagger API

NOTE: We are not endorsed by (or) endorsing any specific LLM codebase (or) against developers writing client code by themselves.

API Security

API header

You need the following parameters to call this API over HTTPS, all of which needs to be passed through on the headers.

X-id & X-auth : both of which needs to be provided by us. These are typically locked down to your IP (inbound IP for us). If you have a fluid IP, then do connect with us to discuss more

X-pass : This is the password that you want to test against

NOTE: When the Auth credentials are provided, they are locked down to a specific calling IP, so that only you are allowed to call from that IP using your credentials. If you need to discuss other options - connect with us.

API Body

There is nothing to be passed in the body.

API Response

Refer Home page for the response body of the API in action or "Swagger" documentation above for the Spec

Want to Integrate your System with this PIN API ?

To integrate with this API, you will need a API key. Please do connect with us via email to [email protected] for any integration queries.

Disclaimer

Doing this check does not make your system completely secure. This API check is one of the additional layers of security that you may add to your system. In order to achieve greater security of your systems, it is recommended to add multiple layers of security at every layer of the business - application, network, system, hardware, people and processes. This check of your user's passwords against already leaked passwords at realtime, will give greater assurance at "User Access Security" in your security layers. We attempt to keep the password store updated regularly, though this is not (and may never will be) the complete list of all leaked passwords available in the internet, as the complete list is a moving target, with more and more systems being hacked and more and more user passwords being exposed almost every day.