Skip to main content

Authentication

Suggest Edits

Overview​

Retrieves a JWT token required for API access. In order to utilize any additional functions within this service, it is imperative to obtain a JSON Web Token (JWT) authentication token. This token must be included in the header of your requests to authenticate your access to this web service.

Important Considerations:
By default, all tokens generated without the expiresInHours parameter have no set expiration date, but all tokens are unique. This uniqueness implies that the creation of a new JWT token will render all previous tokens invalid. It is within the discretion of your software to determine the frequency at which the JWT token should be refreshed, adhering to security best practices.

Resource Access​

Production (api.ahrvo.network)

POST https://api.ahrvo.network/banking/echecks/apiServices/uploadChecks.php?Auth

Staging (gateway.ahrvo.network)

POST https://gateway.ahrvo.network/banking/echecks/apiServices/uploadChecks.php?Auth

Arguments​

AttributeMandatory / Optional
aidMandatory
passwordMandatory
expiresInHoursOptional

Example Request​

curl -X POST https://gateway.ahrvo.network/banking/echecks/apiServices/uploadChecks.php?Auth \
  -H "Content-Type: application/json" \
  -H "x-api-key: {apiKey}" \
  -d '{
    "aid": "105963001",
    "password": "*password*",
    "expiresInHours": "9000"
  }'

Example Response​

{
  "errorCode": 0,
  "errorMessage": "",
  "token": "eyJhbGciOiJIUzI1NiIsIn...",
  "exp": null
}

API Documentation​