URL Namespace
All APIs are accessible over HTTPS, the base URL for all API requests is https://{your_app_value}.dev.everifin.com/api/{apiversion}
...
| Info |
|---|
All API requests must use HTTPS scheme, any non-secure (HTTP) requests return a (HTTP 301) redirect to a HTTPS equivalent of the original request URL. |
HTTP verbs
As per RESTful design patterns, our API implements the following HTTP verbs:
GET- used for retrieveing objectsPOST- Used for creating objectsPUT- Used for replacing objects or collectionsDELETE- Used for deleting objects
Parameters
Many API methods take parameters.
For
GET requests, any parameters not specified as a segment in the path can be passed as an HTTP query string parameter:
Media types
The API currently only supports JSON as an exchange format. Be sure to set both the Content-Type and Accept headers for every request as application/json.
All Date objects are returned in ISO 8601 format:
YYYY-MM-DDTHH:mm:ss.SSSZ
Client request context
Everifin will derive client request context directly from the HTTP request headers. These headers are then forwarded as client information to bank APIs (usually used for AML, security and logging purposes).
User Agent
User agent header should be present in all requests. This should be the User Agent of the actual end user (client of the bank) using your application, whenever possible.
IP address
client-ip-address header should be present in all requests. This should be the IP Address of the actual end user (client of the bank) using your application, whenever possible.
Errors
All requests on success will return a 200 status if there is content to return or a 204 status if there is no content to return.
...
See /wiki/spaces/DOCS/pages/1136918539, and /wiki/spaces/DOCS/pages/1136853019 for a list of API error codes and more details.
Pagination
Requests that return a list of objects may support pagination. Pagination is based on a page number or on cursor. The cursor is readable by the client (it is a Date object) and specified in updatedFrom query parameter. You can also set a custom page size with the countPerPage parameter.
...