Introduction
Accounts
Update contact info
Money Movement
Disclosures
Banking Images
Authentication
Alerts
Banking Activity
Unlock User
Legacy Authentication
Reset Password
Experience Group
Customer Information
Transactions
E-Statement Reports
.png)
Revoke token
ENDPOINTS
delete
/v1/revoke
Header parameters
Collapse
Accept
string
no
institutionId
string
required
Numeric unique id of the financial institution
transactionId
string
required
A unique identifier for this request.
Content-Type
string
required
Request content type
Authorization
string
required
Standard HTTP Basic Authentication based on the 'shared key', and 'secret key', provided during the application registration process.A string composed of `Basic`+ `(space)` + `base64encode(shared_key + ":" + secret_key)`example: Basic ODU4S0pRczVXwGdMRkhUUUh
Body parameters
Collapse
{"grant_type":"string","username":"string","password":"string","scopes":"string","refresh_token":"string"}
Responses
Collapse
200
Token successfully created
Response Body
{"expires_in":"string","di_fiid":"string","di_ficustomer":"string","access_token":"string","refresh_token":"string","refresh_token_expires_in":"string"}
200
Token successfully created
Response Body
{"expires_in":"string","di_fiid":"string","di_ficustomer":"string","access_token":"string","refresh_token":"string","refresh_token_expires_in":"string"}
400
Bad Request. Returned when the submitted request does not match the requirements defined in the specification
Response Body
{"statusMessage":"string","errorInfo":{"errorType":"USER_ERROR","errorCode":"string","errorMessage":"string"}}
400
Bad Request. Returned when the submitted request does not match the requirements defined in the specification
Response Body
{"statusMessage":"string","errorInfo":{"errorType":"USER_ERROR","errorCode":"string","errorMessage":"string"}}
401
Unauthorized. Returned when the authentication request is unsuccessful
Response Body
{"statusMessage":"string","errorInfo":{"errorType":"USER_ERROR","errorCode":"string","errorMessage":"string"}}
401
Unauthorized. Returned when the authentication request is unsuccessful
Response Body
{"statusMessage":"string","errorInfo":{"errorType":"USER_ERROR","errorCode":"string","errorMessage":"string"}}
500
Internal Server Error. Returned when an unexpected fault occurs whilst processing the request
Response Body
{"statusMessage":"string","errorInfo":{"errorType":"USER_ERROR","errorCode":"string","errorMessage":"string"}}
500
Internal Server Error. Returned when an unexpected fault occurs whilst processing the request
Response Body
{"statusMessage":"string","errorInfo":{"errorType":"USER_ERROR","errorCode":"string","errorMessage":"string"}}
CURL REQUEST
curl -X 'DELETE' \
'https://api.candescent.com/digitalbanking/oauth2/v1/revoke' \
-H 'authorization: SOME_STRING_VALUE' \
-H 'content-type: SOME_STRING_VALUE' \
-H 'transactionid: SOME_STRING_VALUE' \
-H 'institutionid: SOME_STRING_VALUE' \
-H 'accept: SOME_STRING_VALUE' \ RESPONSE
{"userId":"string","institutionCustomerId":"string","userName":"string","password":"string","oldPassword":"string","alternateCredentialValue":"string","alternateCredentialType":"FACE_ID","institutionId":"string","deviceId":"string","requestChannel":"WEB","oneTimePasscode":"string","passwordExpiryInDays":"string","passwordExpiryWarningInDays":"string","passwordPostponementPeriodInDays":"string","ticket":"string","status":"SECONDARY_AUTHENTICATION_REQUIRED","phoneNumbers":{"phoneNumber":{"id":"string","countryCode":"string","number":"string","protocol":"SMS"}},"validatedPhoneNumbers":{"phoneNumber":{"id":"string","countryCode":"string","number":"string","protocol":"SMS"}},"validatedEmail":{"id":"string","address":"string"},"validatedVipToken":{"id":"string","credentialId":"string"},"validatedTotpToken":{"id":"string"},"secondaryAuthCookies":{"name":"string","value":"string","maxAge":0},"privateDevice":true,"scopes":{"scope":{"name":"string","description":"string"}},"redirectUri":"string","clientId":"string","clientSecret":"string","grantType":"AUTHORIZATION_CODE","state":"string","additionalInfo":{"entry":[{"key":"string","value":"string"}]}}
null
{"code":"string","message":"string"}
{"code":"string","message":"string"}
