{ "opencollection": "1.0.0", "info": { "name": "Plaid identity/", "version": "2020-09-14_1.517.0" }, "items": [ { "info": { "name": "Plaid", "type": "folder" }, "items": [ { "info": { "name": "Plaid Retrieve identity data", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/identity/get", "body": { "type": "json", "data": "{}" } }, "docs": "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. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution.\n\nThis request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve t" }, { "info": { "name": "Plaid Returns uploaded document identity", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/identity/documents/uploads/get", "body": { "type": "json", "data": "{}" } }, "docs": "Use `/identity/documents/uploads/get` to retrieve document uploaded identity." }, { "info": { "name": "Plaid Retrieve identity match score", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/identity/match", "body": { "type": "json", "data": "{}" } }, "docs": "The `/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution.\n\nFields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data.\n\nThis request may take some time to complete if Identity was not specified as an i" }, { "info": { "name": "Plaid Refresh identity data", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/identity/refresh", "body": { "type": "json", "data": "{}" } }, "docs": "`/identity/refresh` is an optional endpoint for users of the Identity product. It initiates an on-demand extraction to fetch the most up to date Identity information from the Financial Institution. This on-demand extraction takes place in addition to the periodic extractions that automatically occur for any Identity-enabled Item. If changes to Identity are discovered after calling `/identity/refresh`, Plaid will fire a webhook [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/identity/#defa" }, { "info": { "name": "Plaid Retrieve Identity data", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/processor/identity/get", "body": { "type": "json", "data": "{}" } }, "docs": "The `/processor/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses." }, { "info": { "name": "Plaid Retrieve identity match score", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/processor/identity/match", "body": { "type": "json", "data": "{}" } }, "docs": "The `/processor/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution.\n\nFields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data.\n\nThis request may take some time to complete if Identity was not specifi" } ] } ], "bundled": true }