Skip to main content

Accessing the API

The API is accessible via HTTPS and uses JSON for requests and JSON for responses.

The API endpoints are:

  • Live: https://api.finperks.com
  • Sandbox: https://api-sandbox.finperks.com (use this for development)

HTTPS/TLS Protocols and Certificates​

We utilize TLS protocols to ensure secure communications between our systems and our partners' systems. Our systems currently supports both TLS 1.2 and TLS 1.3, using a range of secure encryption ciphers. We expect our partners to implement support for these protocols in their systems as well, to guarantee secure data transmission.

We require our partners to maintain an up-to-date list of trusted root certificates (CA Root certificates). This ensures that new HTTPS/TLS connections can be properly verified and trusted, mitigating the risk of man-in-the-middle attacks. We strongly recommend always verifying HTTPS server certificates against trusted root certificates. This includes validating the certificate chain and verifying the server name(s) against the certificate. Refer to your HTTP client’s documentation for details on performing these and other required checks.

Sandbox​

The sandbox mode allows working with the API for development purposes without any actual actions being executed that would require a monetary settlement. Please use the sandbox mode for any integration testing.