Legacy Authentication

API - V 2.5

Download Swagger Spec

Create Access Token

The create access token API provides the means to access all other APIs on the Developer Portal. For example, when calling an API to retrieve a list of a customer’s accounts, your request must provide a valid OAuth Bearer Token. The Get token service provides that token.

ENDPOINTS

post

/v1/oauth/token

Header parameters

Collapse

Expand

Authorization

string

required

Standard HTTP Basic Authentication based on the `consumer key` and `consumer secret` provided during the application registration process.A string composed of `Basic`+ `(space)` + `base64encode(consumer_key + ":" + consumer_secret)`; example `Basic ODU4S0pRczVXwGdMRkhUUUhtSGhNdTRYHlpRa3N1ZGY6STA0UThtMFJZZEF1dUlwYg`

originating_ip

string

The IP address of the device making the request for authentication.If not provided the IP address logged will be the IP address extracted from the HTTP requestNote: this should be the originating device, rather than the client making the request e.g. if a mobile device is used the ip address should be that of the mobile device, rather than a back end service

user-agent

string

required

Identifies the application and the platform making the request.The expected format is `{Appname}/{Appversion}[/{DeviceID}][;{Platform User-Agent}]` e.g. iPhone/1.0/abc12345;Nokia3110

di_tid

string

required

Unique id used to identify the request. The id allows the request to be traced through the entire request and response flow. The expected id is a UUID, in the canonical form e.g 123e4567-e89b-12d3-a456-426655440000

offering_id

string

Uniquely identifies the name of the client app making the request.When not provided this is derived based on a property held against the application within Apigee

Body parameters

Collapse

Expand

{"grant_type":"password","username":"string","password":"string"}

Responses

Collapse

Expand

CURL REQUEST

curl --request POST \
  --url https://api.candescent.com/digitalbanking/v1/oauth/token \
  --header 'Authorization: SOME_STRING_VALUE' \
  --header 'accept: application/xml' \
  --header 'content-type: application/x-www-form-urlencoded' \
  --header 'di_fiid: SOME_STRING_VALUE' \
  --header 'di_tid: SOME_STRING_VALUE' \
  --header 'offering_id: SOME_STRING_VALUE' \
  --header 'originating_ip: SOME_STRING_VALUE' \
  --header 'user-agent: SOME_STRING_VALUE' \
  --data '{"grant_type":"password","username":"String","password":"String"}'

Get Response

RESPONSE

{"expires_in":"string","di_fiid":"string","di_ficustomer":"string","access_token":"string","refresh_token":"string","refresh_token_expires_in":"string"}

{"statusMessage":"string","errorInfo":{"errorType":"USER_ERROR","errorCode":"string","errorMessage":"string"}}

Log out

Main menu

Introduction

Accounts

Update contact info

Money Movement

Disclosures

Banking Images

Authentication

Checks

Alerts

Banking Activity

Unlock User

Customer