Match Linked Institution Account Identity

Use the linked-institution/identity-match endpoint to compare the account owner details held by the institution against the identity on the Spidr user record. Supply the linkedInstitutionId, and optionally the linkedInstitutionAccountIds you want scored. If you do not supply account IDs, every active account on the linked institution is scored.

The response returns the linked institution with an identityMatch object on each scored account, holding the legal name, phone number, email address and address scores. Each score is a raw value from 0 to 100, and is null when there is no data on one of the two sides to compare. Spidr applies no threshold, so you decide what score you accept. An account that has never been scored omits the identityMatch object. An account you leave out of the request keeps the scores it already has.

The account_verification_with_match service must be enabled on the product, and the linked institution must be in success status and free of provider errors. If the account owner details are not already held for an account, they are fetched from the institution before the match runs. If the linked institution was created without account verification, that first fetch is billed once, as a one-time account owner charge for the linked institution. Each call to this endpoint is billable, and a repeat call overwrites the stored scores and the matchedAt timestamp. The scores are stored, so Fetch Linked Institutions and Accounts returns the same values without calling the provider and at no cost.

Body Params

POST /v1/linked-institution/identity-match Request body

string
required

Pass in the linked institution ID

linkedInstitutionAccountIds
array of strings

Optional array of linked institution account IDs to match. If not provided, all active accounts on the linked institution are matched.

linkedInstitutionAccountIds
Responses

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