Match User

Match a user against users who have connected to Open Banking and consented for their data to be shared using a hashed email address and date of birth. When a matching user is found, the response returns the matched userId along with the consent expiry, the date after which the partner can no longer access that user's Open Banking data.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Applicant details used to perform the match.

string
required
^[a-fA-F0-9]{64}$

SHA-256 hash of the applicant's email address, encoded as 64 hexadecimal characters. The email address should be lowercased before hashing.

date
required

Applicant's date of birth in ISO 8601 date format.

Headers
string
enum
required

Purpose of the match request.

Allowed:
Responses

401

API key authentication unsuccessful.

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