Banking

API - V 2.5

Download Swagger Spec

Get FI Customer

Retrieves digital banking profile information for a customer.

ENDPOINTS

get

/v2/fis/{fiId}/fiCustomers/{fiCustomerId}

Header parameters

Collapse

Expand

Cache-Control

string

Optional. Valid value is no-cache. If the caller includes this header value, CBS will empty the cache for the user (regardless of its age) and go to the database to get a fresh copy of the data.

string

Optional. The data format the client expects to receive in the response. Currently the only supported value application/xml. In the future we will support application/json. If no value is provided, the default is application/xml.

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

user-agent

string

Identifies the application and the platform making the request. The expected format is {Appname}/{Appversion}[/{DeviceID}] [;{Platform User-Agent}]

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 request Note: 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

Date

string

The date and time that the message was sent. The expected format is UTC e.g. 1994-11-05T13:15:30Z

Authorization

string

required

Standard OAuth 2.0 access token. A string composed of `Bearer` + `(space)` + `{token}`; example `Bearer rvYKAItOGiMQy1yOHdUDAHWp2HG1`

di_tid

string

required

Unique id used to identify the request. The id allows the request to be traced through the entire request and reponse flow. The value should appear in UUID format. For example, 123e4567-e89b-12d3-a456-426655440000.

Query parameters

Collapse

Expand

operation

string

Optional. Supported values are getPFMUser.

fiCustomerIdType

string

Optional. Valid values are GUID (default, internal ID), MEMNUMBER, LOGINID, and HOSTID. If not specified, the value for fiCustomers in the URL must the be the internal GUID. If the value is MEMNUMBER, the value for fiCustomers in the URL must be the ID value known to the financial institution's core system. If the value is LOGINID the value is the customer's digital banking login ID.

Path parameters

Collapse

Expand

fiCustomerId

string

required

the ID for the requested customer. This may be specified with various values, depending on the fiCustomerIDType parameter. The default is to send the internal ID.

fiId

string

required

the ID assigned to the financial institution.

Responses

Collapse

Expand

Response Body

CURL REQUEST

curl -X 'GET' \ 
 'https://api.candescent.com/digitalbanking/bankingservices/v2/fis/{fiId}/fiCustomers/{fiCustomerId}' \ 
 -H 'di_tid: SOME_STRING_VALUE' \ 
 -H 'authorization: SOME_STRING_VALUE' \ 
 -H 'date: SOME_STRING_VALUE' \ 
 -H 'originating_ip: SOME_STRING_VALUE' \ 
 -H 'user-agent: SOME_STRING_VALUE' \ 
 -H 'offering_id: SOME_STRING_VALUE' \ 
 -H 'accept: SOME_STRING_VALUE' \ 
 -H 'cache-control: SOME_STRING_VALUE' \

Get Response