The end user wants to get the list of accounts or a specific account from the bill pay system.
The user in this case is the customer of FI.
Get all disclosures for a financial institution
Get list of all disclosures GET /db-disclosures/v1/institution-disclosures
Request:
Headers:
- Authorization: The bearer access token from the Authentication API
- TransactionId: A UUID string used as unique identifier for this token request
- callingAppId: An ID of the application that made this request.
Creates a disclosure for a financial institution
Create a disclosure POST /db-disclosures/v1/institution-disclosures
Request:
Headers:
- Authorization: The bearer access token from the Authentication API
- TransactionId: A UUID string used as unique identifier for this token request
- callingAppId: An ID of the application that made this request.
- InstitutionId: Unique identifier for the FI
- InstitutionDisclosureName: Name of the disclosureInstitution
- InstitutionDisclosureStatus: true/false, the status of the disclosure
Sample Body:
{
"institutionId": "01111",
"institutionDisclosureName": "TEST\_DISCLOSURE",
"institutionDisclosureStatus": false
}
Updates a disclosure for a Financial institution
Change a disclosure PUT /db-disclosures/v1/institution-disclosures/{institutionDisclosureId}
Request:
Path Variables:
- institutionDisclosureId: Unique identifier for disclosureId
Headers:
- Authorization: The bearer access token from the Authentication API
- TransactionId: A UUID string used as unique identifier for this token request
- callingAppId: An ID of the application that made this request.
- InstitutionId: Unique identifier for the FI
- InstitutionDisclosureName: Name of the disclosureInstitution
- InstitutionDisclosureStatus: true/false, the status of the disclosure
Sample Body:
{
"institutionDisclosureId": "3783DC81C95C35F3E0530B9D680AC6FB",
"institutionId": "01111",
"institutionDisclosureName": "TEST\_DISCLOSURE1",
"institutionDisclosureStatus": false
}
Get all the disclosures accepted by a user
Get list of all user disclosures GET /db-disclosures/v1/institution-user-disclosures
Request:
QueryParameter:
- InstitutionConsumerId: Unique identifier for a consumer user
Headers:
- Authorization: The bearer access token from the Authentication API
- TransactionId: A UUID string used as unique identifier for this token request
- callingAppId: An ID of the application that made this request.
Creates a user disclosure acceptance record for a specific user
Create a disclosure POST /db-disclosures/v1/institution-user-disclosures
Request:
Headers:
- Authorization: The bearer access token from the Authentication API
- TransactionId: A UUID string used as unique identifier for this token request
- callingAppId: An ID of the application that made this request.
- InstitutionUserDisclosureStatus: The status of the user disclosure e.g.: Accepted
- InstitutionDisclosureName: Name of the disclosureInstitution
- AccountId: Unique account ID
- InstitutionDisclosureId: Unique disclosure ID
- InstitutionUserDisclosureStatusUpdateDateTime: DateTime stamp
Sample Body:
{
"institutionUserDisclosureStatus": "ACCEPTED",
"institutionDisclosureName": "IB"
}
Updates an existing user disclosure
Change a user disclosure PUT /db-disclosures/v1/institution-user-disclosures
PUT /db-disclosures/v1/institution-user-disclosures/{institutionUserDisclosureId}
Request:
Query Parameter:
- InstitutionCustomerId: The ID of the user with which this recipient is associated (mandatory for business banking requests)
Path Parameter:
- institutionUserDisclosureId: Unique identifier for user disclosure. This is used only when using /db-disclosures/v1/institution-user-disclosures/{institutionUserDisclosureId}
Headers:
- Authorization: The bearer access token from the Authentication API
- TransactionId: A UUID string used as unique identifier for this token request
- callingAppId: An ID of the application that made this request.
- InstitutionDisclosureId: Unique disclosure ID. This is required when update is CAS-related only.
- InstitutionUserDisclosureStatus: The status of the user disclosure e.g.: Accepted
- InstitutionDisclosureName: Name of the disclosure
Sample Body:
{
"institutionDisclosureId": "77174ad5c3b549c6ab0ab1e287d1f7e4",
"institutionDisclosureName": "IB",
"institutionDisclosureStatus": "NOT\_ACCEPTED"
}
Deletes a specific user disclosure previously accepted by the user
Delete a specific user disclosure DELETE /db-disclosures/v1/institution-user-disclosures
DELETE /db-disclosures/v1/institution-user-disclosures/{institutionUserDisclosureId}
Request:
Query Parameter:
- InstitutionCustomerId: The ID of the user with which this recipient is associated (mandatory for Business banking requests) - AccountType: A valid DI account type (mandatory for multi statement disclosures)
Path Parameter:
- institutionUserDisclosureId: Unique identifier for user disclosure. This is used only when using /db-disclosures/v1/institution-user-disclosures/{institutionUserDisclosureId}
Headers:
InstitutionUserDisclosureStatus: The status of the user disclosure e.g.: Accepted
AccountId: Unique accountId
- Authorization: The bearer access token from the Authentication API
- TransactionId: A UUID string used as unique identifier for this token request
- callingAppId: An ID of the application that made this request.
- InstitutionUserDisclosureStatus: The status of the user disclosure e.g.: Accepted
- AccountId: Unique accountId
Sample Body:
{
"institutionDisclosureName": "OLS",
"accountId":"joOTTF8wTpUDFc6t\_f40sLzOnl8Bjpw0vXjSJ4KGazw"
}
Creates a disclosure for a Financial institution
Sample Response:
{
"institutionDisclosures": [
{
"institutionDisclosureId": "3783DC81C95C35F3E0530B9D680AC6FB",
"institutionId": "05526",
"institutionDisclosureName": "ESIGNACT\_2"
},
{
"institutionDisclosureId": "7F9BC8BC40A00E25E053D097660A296B",
"institutionId": "05526",
"institutionDisclosureName": "TCPA\_ACCEPTANCE",
"institutionDisclosureData": "NULL\n",
"institutionDisclosureDataType": "URL",
"institutionDisclosureStatus": true
},
]
}
Creates a disclosure for a Financial institution
Sample Response:
{
"institutionDisclosureId": "887803AED49E76F8E0538B88660A3518",
"institutionDisclosureName": "CREAT\_DISC\_NAME",
"institutionDisclosureData": "[http://candescent.com/disclosures](http://candescent.com/disclosures)",
"institutionDisclosureDataType": "URL"
}
Updates a disclosure for a Financial institution
Sample Response:
{
"institutionDisclosureId": "77174ad5c3b549c6ab0ab1e287d1f7e4",
"institutionId": "02088",
"institutionDisclosureName": "bc6ee03-87d9-4b01-9",
"institutionDisclosureData": "[http://candescent.com/bc6ee03-87d9-4b01-9](http://candescent.com/bc6ee03-87d9-4b01-9)",
"institutionDisclosureDataType": "URL"
}
Get all the disclosures accepted by a user
Sample Response:
{
"institutionUserDisclosures": [
{
"institutionId": "01111",
"institutionUserId": "DBB989931B333CD6E0434503910A170D",
"institutionUserDisclosureStatus": "NOT\_ACCEPTED",
"institutionDisclosureName": "ESIGN"
},
{
"institutionId": "01111",
"institutionUserId": "DBB989931B333CD6E0434503910A170D",
"institutionUserDisclosureStatus": "ACCEPTED",
"institutionDisclosureName": "OLS"
},
]
}
Creates a user disclosure acceptance record for a specific user
Response:
Returns 204 for successful response without content
Updates an existing user disclosure
Response:
Returns 204 for successful response without content
Deletes a specific user disclosure previously accepted by the user
Response:
Returns 204 for successful response without content
