Match Identity

POST https://{{env_url}}/identity/match

The /identity/get endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.

Request Body

{"client_id"=>"{{client_id}}", "secret"=>"{{secret_key}}", "access_token"=>"{{access_token}}", "user"=>{"phone_number"=>"+1-111-222-3333", "legal_name"=>"Alerta Charleson", "email_address"=>"accountholder1@example.com", "address"=>{"city"=>"San Matias", "country"=>"US", "postal_code"=>"93405", "region"=>"CA", "street"=>"2493 Leisure Ln."}}}

HEADERS

RESPONSES

status: OK

{"accounts":[{"account_id":"WVKAeeg5wgIJ1rmgnMd1HZXzmpyzmGCPrePR1","address":{"is_postal_code_match":true,"score":100},"balances":{"available":100,"current":110,"iso_currency_code":"USD","limit":null,"unofficial_currency_code":null},"email_address":{"score":100},"legal_name":{"is_business_name_detected":false,"is_first_name_or_last_name_match":true,"is_nickname_match":false,"score":91},"mask":"0000","name":"Plaid Checking","official_name":"Plaid Gold Standard 0% Interest Checking","persistent_account_id":"8cfb8beb89b774ee43b090625f0d61d0814322b43bff984eaf60386e","phone_number":{"score":100},"subtype":"checking","type":"depository"},{"account_id":"A6qWvvbR5bHEzqMVvPazcmgb91Lb9WS47q48P","address":{"is_postal_code_match":true,"score":100},"balances":{"available":200,"current":210,"iso_currency_code":"USD","limit":null,"unofficial_currency_code":null},"email_address":{"score":100},"legal_name":{"is_business_name_detected":false,"is_first_name_or_last_name_match":true,"is_nickname_match":false,"score":91},"mask":"1111","name":"Plaid Saving","official_name":"Plaid Silver Standard 0.1% Interest Saving","persistent_account_id":"211a4e5d8361a3afb7a3886362198c7306e00a313b5aa944c20d34b6","phone_number":{"score":100},"subtype":"savings","type":"depository"},{"account_id":"GAj6EEB5bBfaropmGWercdXWRNQWRAtGlDGao","address":{"is_postal_code_match":true,"score":100},"balances":{"available":null,"current":1000,"iso_currency_code":"USD","limit":null,"unofficial_currency_code":null},"email_address":{"score":100},"legal_name":{"is_business_name_detected":false,"is_first_name_or_last_name_match":true,"is_nickname_match":false,"score":91},"mask":"2222","name":"Plaid CD","official_name":"Plaid Bronze Standard 0.2% Interest CD","persistent_account_id":"2a01484e1b5ef0b54fbcb89658b2764529bbec94a16f7b95481280a7","phone_number":{"score":100},"subtype":"cd","type":"depository"},{"account_id":"neB9331zm1tW537ojJb5cw9WkaZWk6s3d13oM","address":{"is_postal_code_match":true,"score":100},"balances":{"available":null,"current":410,"iso_currency_code":"USD","limit":2000,"unofficial_currency_code":null},"email_address":{"score":100},"legal_name":{"is_business_name_detected":false,"is_first_name_or_last_name_match":true,"is_nickname_match":false,"score":91},"mask":"3333","name":"Plaid Credit Card","official_name":"Plaid Diamond 12.5% APR Interest Credit Card","phone_number":{"score":100},"subtype":"credit card","type":"credit"},{"account_id":"br8o99QJeQTW5xJR9815cpWGdqPGd5uo5Aoln","address":{"is_postal_code_match":true,"score":100},"balances":{"available":43200,"current":43200,"iso_currency_code":"USD","limit":null,"unofficial_currency_code":null},"email_address":{"score":100},"legal_name":{"is_business_name_detected":false,"is_first_name_or_last_name_match":true,"is_nickname_match":false,"score":91},"mask":"4444","name":"Plaid Money Market","official_name":"Plaid Platinum Standard 1.85% Interest Money Market","phone_number":{"score":100},"subtype":"money market","type":"depository"},{"account_id":"m7rwBBZkWZIVrQwGnjbrTe8yzd3yzoF4bB4Ep","address":{"is_postal_code_match":true,"score":100},"balances":{"available":null,"current":320.76,"iso_currency_code":"USD","limit":null,"unofficial_currency_code":null},"email_address":{"score":100},"legal_name":{"is_business_name_detected":false,"is_first_name_or_last_name_match":true,"is_nickname_match":false,"score":91},"mask":"5555","name":"Plaid IRA","official_name":null,"phone_number":{"score":100},"subtype":"ira","type":"investment"},{"account_id":"yyARZZze9zhW8xAaLrp8c1oXvy6Xv7tK9VKG6","address":{"is_postal_code_match":true,"score":100},"balances":{"available":null,"current":23631.9805,"iso_currency_code":"USD","limit":null,"unofficial_currency_code":null},"email_address":{"score":100},"legal_name":{"is_business_name_detected":false,"is_first_name_or_last_name_match":true,"is_nickname_match":false,"score":91},"mask":"6666","name":"Plaid 401k","official_name":null,"phone_number":{"score":100},"subtype":"401k","type":"investment"},{"account_id":"9DGjggNAWNhRzjmv3ZqzF6qoRW9oRnFqLdqrN","address":{"is_postal_code_match":true,"score":100},"balances":{"available":null,"current":65262,"iso_currency_code":"USD","limit":null,"unofficial_currency_code":null},"email_address":{"score":100},"legal_name":{"is_business_name_detected":false,"is_first_name_or_last_name_match":true,"is_nickname_match":false,"score":91},"mask":"7777","name":"Plaid Student Loan","official_name":null,"phone_number":{"score":100},"subtype":"student","type":"loan"},{"account_id":"vypJ779Pb9hAgzQ5o37gumdkj6Kkj7SvjyvpM","address":{"is_postal_code_match":true,"score":100},"balances":{"available":null,"current":56302.06,"iso_currency_code":"USD","limit":null,"unofficial_currency_code":null},"email_address":{"score":100},"legal_name":{"is_business_name_detected":false,"is_first_name_or_last_name_match":true,"is_nickname_match":false,"score":91},"mask":"8888","name":"Plaid Mortgage","official_name":null,"phone_number":{"score":100},"subtype":"mortgage","type":"loan"}],"item":{"available_products":["assets","auth","balance","income","investments","liabilities","transactions"],"billed_products":["identity"],"consent_expiration_time":null,"error":null,"institution_id":"ins_20","item_id":"5RLa11GgzGhJ8arz69k8H1bzVjj9obFZnV8J6","optional_products":null,"products":["identity"],"update_type":"background","webhook":"https://www.genericwebhookurl.com/webhook"},"request_id":"tuO0BmExrKFlRgJ"}