Refresh Linked Institution and Accounts

Use the linked-institution/refresh endpoint to refresh the data of a linked institution. This endpoint will re-fetch the latest information and account data from the linked institution, ensuring that you have the most up-to-date data available.

Supply vendorServices to choose what is refreshed. Include account_verification_with_match to re-run the identity match and overwrite the stored scores; the service must be enabled on the product, and each match run is billable. A request that does not name account_verification_with_match, including a request that omits vendorServices entirely, never runs a match. Stored scores are left unchanged and are still returned.

account_verification and account_verification_with_match cannot be requested together. A linked institution holds at most one of the two: refreshing an account_verification linked institution with account_verification_with_match replaces the stored value, and refreshing an account_verification_with_match linked institution with account_verification keeps account_verification_with_match. If the product enrolls account_verification but no longer enrolls account_verification_with_match, a linked institution that holds both keeps account_verification.

If the refresh reads the account owner details for a linked institution that was created without account verification, that first read is billed once, as a one-time account owner charge for the linked institution. A later read of the same institution is not billed again.

Path Params
string
required

Pass in the linked institution ID

Body Params

POST /v1/linked-institution/:linkedInstitutionId/refresh Request body

vendorServices
array of strings

The service(s) to refresh. Defaults to the services stored on the linked institution. Include account_verification_with_match to re-run the identity match and overwrite the stored scores; each match run is billable. A request that does not name account_verification_with_match never runs a match and leaves the stored scores unchanged. account_verification and account_verification_with_match cannot be requested together.

vendorServices
Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json