![\"\"](\"https://raw.githubusercontent.com/Mastercard/finicity-openapi/main/res/logo.png\"){kind=logo}
Contact Support:\n Name: Finicity\n Email: business.development@finicity.com
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"11339178","collectionId":"4c4f69e1-cb07-4843-877c-ea3704e72a63","publishedId":"2s93eYUsLS","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-05-08T08:30:29.000Z"},"item":[{"name":"Quick Start","item":[{"name":"Welcome Your First Customer","item":[{"name":"Step 1 - Create Access Token","event":[{"listen":"test","script":{"id":"f8288171-5cc5-4f49-9d63-61c558a54676","exec":["if (pm.response.code == 403) {\r"," throw Error(\"HTTP 403. Make sure you are located in the US, UK or Canada.\")\r","}\r","pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equals(200)\r","})\r","\r","/* Store the token and expiry date in global variables */\r","const tokenValue = pm.response.json().token\r","const expiryDate = new Date()\r","expiryDate.setMinutes(expiryDate.getMinutes() + 90)\r","pm.globals.set(\"appToken\", tokenValue)\r","pm.globals.set(\"appTokenExpiry\", expiryDate)"],"type":"text/javascript"}}],"id":"25658189-077a-4847-9ad6-096c14ea8f3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partnerId\": \"2445584195057\",\n \"partnerSecret\": \"Xb0dkA6h9fXn5gqLkfrI\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/aggregation/v2/partners/authentication","description":"Send Partner ID and Partner Secret to the Partner Authentication service to obtain a token for accessing Finicity APIs.
\nSupported regions: ![\"πΊπΈ\"](\"https://flagcdn.com/20x15/us.png\")
Enroll a testing customer (Test Drive accounts).
\nFor using testing customers with FinBank OAuth, you must register a test application with your systems engineer or account manager. Then, use that testing applicationId when creating testing customers.
Testing Customers can access FinBank profiles (except \"FinBank Billable\" profiles), and cannot access live financial institutions.
\nSupported regions:
Generate a Connect 2.0 URL link to add within your own applications.
\nIn option, use the experience parameter to call Connect (per session) in the body of the request. Configure the experience parameter to change the brand color, logo, icon, which credit decisioning report to generate when the Connect application completes, and more.
Note: contact your Sales Account Team to set up the experience parameter.
MVS Developers: You can pre-populate the consumer's SSN on the \"Find employment records\" page at the beginning of the MVS payroll app. Pass the SSN value for the consumer in the body of the request call.
\nSupported regions:
Follow Step 4 - Sign-in to FinBank and submit accounts
\n","urlObject":{"protocol":"Follow Step 4 here => https","path":["3Z1ekdU"],"host":["mstr","cd"],"query":[],"variable":[]}},"response":[],"_postman_id":"7da475c0-0e87-48f1-8e9a-31ab51520d82"},{"name":"Step 5 - Refresh Customer Accounts","event":[{"listen":"test","script":{"id":"f365863a-b22c-4f6b-9b91-6a7b75fb5a7a","exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equals(200)\r","})"],"type":"text/javascript"}}],"id":"9148af29-360a-423d-856a-ebe9f308d8e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/aggregation/v1/customers/6025984717/accounts","description":"Refresh account and transaction data for all accounts associated with the given customerId with a connection to the institution.
Client apps are not permitted to automate calls to the Refresh services. Active accounts are automatically refreshed by Finicity once per day. Because many financial institutions only post transactions once per day, calling Refresh repeatedly is usually a waste of resources and is not recommended.
\nApps may call Refresh services for a specific customer when there is a specific business case for the need of data that is up to date as of the moment. Please discuss with your account manager and systems engineer for further clarification.
\nThe recommended timeout setting for this request is 120 seconds in order to receive a response. However, you can terminate the connection after making the call the operation will still complete. You will have to pull the account records to check for an updated aggregation attempt date to know when the refresh is complete.
\nSupported regions:
Refresh account and transaction data for all accounts associated with the given customerId with a connection to the institution.
Client apps are not permitted to automate calls to the Refresh services. Active accounts are automatically refreshed by Finicity once per day. Because many financial institutions only post transactions once per day, calling Refresh repeatedly is usually a waste of resources and is not recommended.
\nApps may call Refresh services for a specific customer when there is a specific business case for the need of data that is up to date as of the moment. Please discuss with your account manager and systems engineer for further clarification.
\nThe recommended timeout setting for this request is 120 seconds in order to receive a response. However, you can terminate the connection after making the call the operation will still complete. You will have to pull the account records to check for an updated aggregation attempt date to know when the refresh is complete.
\nSupported regions:
Steps from the Quick Start Guide to create a test customer and share some test accounts with Mastercard Open Banking. The corresponding Customer ID can then be used for retrieving account and financial data.
\n","_postman_id":"c2eb9c73-c33e-40ef-8e84-2585c84fdc15"}],"id":"ac67e4e5-87d0-4bf7-a76c-9c434210a18f","description":"Steps from the Quick Start Guide to create a test customer and share some test accounts with Mastercard Open Banking. The corresponding Customer ID can then be used for retrieving account and financial data.
\n","_postman_id":"ac67e4e5-87d0-4bf7-a76c-9c434210a18f"},{"name":"All APIs","item":[{"name":"Accounts","item":[{"name":"Get Customer Accounts by Institution Login ID","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equals(200)\r","})"],"type":"text/javascript","id":"d79c65d7-39ec-4f90-925a-bc70d7f0a1a0"}}],"id":"9f15a67e-a457-4148-a774-1c364e5c4a81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"}],"url":"https://api.finicity.com/aggregation/v1/customers/6025984717/institutionLogins/{{institutionLoginId}}/accounts","description":"Get all accounts associated with the given institution login. All accounts returned are accessible by a single set of credentials on a single institution.
\nSupported regions:
Refresh account and transaction data for all accounts associated with a given institutionLoginId with a connection to the institution.
Client apps are not permitted to automate calls to the Refresh services. Active accounts are automatically refreshed by Finicity once per day. Because many financial institutions only post transactions once per day, calling Refresh repeatedly is usually a waste of resources and is not recommended.
\nApps may call Refresh services for a specific customer when there is a specific business case for the need of data that is up to date as of the moment. Please discuss with your account manager and systems engineer for further clarification.
\nThe recommended timeout setting for this request is 120 seconds in order to receive a response. However, you can terminate the connection after making the call the operation will still complete. You will have to pull the account records to check for an updated aggregation attempt date to know when the refresh is complete.
\nNote: This service is not available for all tiers of dynamic billing.
\nSupported regions:
Refresh account and transaction data for all accounts associated with a given 'institutionLoginId` with a connection to the institution. Client apps are not permitted to automate calls to the Refresh services. Active accounts are automatically refreshed by Finicity once per day.
\nApps may call Refresh services for a specific customer when there is a specific business case for the need of data that is up to date as of the moment. Please discuss with your account manager and systems engineer for further clarification.
\nNote: This service will be used for dynamic billing tiers ASD, AFD and ATD.
\nSupported regions:
Remove from Finicity aggregation the set of accounts matching the institution login ID.
\nSupported regions:
Get a customer account by ID.
\nSupported regions:
Remove the given account from Finicity aggregation.
\nSupported regions:
Get all accounts owned by the given customer.
\nSupported regions:
A filter to fetch account in the given status
\n","type":"text/plain"},"key":"status","value":"pending"}],"variable":[]}},"response":[{"id":"c611860e-59f9-471a-a182-2824908fecd4","name":"The account list was successfully retrieved","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v1/customers/:customerId/accounts?status=pending","host":["https://api.finicity.com"],"path":["aggregation","v1","customers",":customerId","accounts"],"query":[{"key":"status","value":"pending"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"8c2eab91-5978-4094-92d8-b9d00ac6948b","name":"The request was rejected","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v1/customers/:customerId/accounts?status=pending","host":["https://api.finicity.com"],"path":["aggregation","v1","customers",":customerId","accounts"],"query":[{"key":"status","value":"pending"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"0d91f1a6-67f3-46fa-9e02-d130901b31ca","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v1/customers/:customerId/accounts?status=pending","host":["https://api.finicity.com"],"path":["aggregation","v1","customers",":customerId","accounts"],"query":[{"key":"status","value":"pending"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"06ce616f-0ed5-42e6-af1e-8ecd0f620298","name":"The resource doesn't exist","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v1/customers/:customerId/accounts?status=pending","host":["https://api.finicity.com"],"path":["aggregation","v1","customers",":customerId","accounts"],"query":[{"key":"status","value":"pending"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"}],"_postman_id":"291f28cf-bfa7-40ec-aba1-204c0e995d67"},{"name":"Refresh Customer Accounts","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equals(200)\r","})"],"type":"text/javascript","id":"a71ebee7-d9e0-4925-9379-cb10031c6518"}}],"id":"e991fe39-2d1e-436d-91d3-6d01f3518995","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/aggregation/v1/customers/6025984717/accounts","description":"Refresh account and transaction data for all accounts associated with the given customerId with a connection to the institution.
Client apps are not permitted to automate calls to the Refresh services. Active accounts are automatically refreshed by Finicity once per day. Because many financial institutions only post transactions once per day, calling Refresh repeatedly is usually a waste of resources and is not recommended.
\nApps may call Refresh services for a specific customer when there is a specific business case for the need of data that is up to date as of the moment. Please discuss with your account manager and systems engineer for further clarification.
\nThe recommended timeout setting for this request is 120 seconds in order to receive a response. However, you can terminate the connection after making the call the operation will still complete. You will have to pull the account records to check for an updated aggregation attempt date to know when the refresh is complete.
\nNote: This service is not available for all tiers of dynamic billing.
\nSupported regions:
Refresh account and transaction data for all accounts associated with the given customerId with a connection to the institution.
Client apps are not permitted to automate calls to the Refresh services. Active accounts are automatically refreshed by Finicity once per day.\nApps may call Refresh services for a specific customer when there is a specific business case for the need of data that is up to date as of the moment. Please discuss with your account manager and systems engineer for further clarification.
\nNote: This service will be used for dynamic billing tiers ASD, AFD and ATD.
\nSupported regions:
Get all active accounts owned by the given customer at the given institution.
\nSupported regions:
Fetch or refresh customer accounts
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["const baseUrl = pm.collectionVariables.get(\"baseUrl\")","const appKey = pm.environment.get(\"appKey\")","const customerId = pm.environment.get(\"customerId\")","const appToken = pm.globals.get(\"appToken\")","","const institutionLoginId = pm.variables.get(\"institutionLoginId\")","const institutionId = pm.variables.get(\"institutionId\")","const accountId = pm.variables.get(\"accountId\")","if (institutionLoginId && institutionId && accountId) {"," return","}","","","console.log(\"Fetching account ID, institution ID and institution login ID ...\")","const options = {"," url: baseUrl + \"/aggregation/v1/customers/\"+ customerId + \"/accounts\","," method: 'GET',"," header: {"," \"Accept\": \"application/json\","," \"Finicity-App-Key\": appKey,"," \"Finicity-App-Token\": appToken"," }","}","pm.sendRequest(options, function (err, response) {"," pm.expect(err).to.be.null"," pm.expect(response.code).to.equals(200)"," const account = response.json().accounts[0]"," pm.variables.set(\"institutionLoginId\", account.institutionLoginId)"," pm.variables.set(\"institutionId\", account.institutionId)"," pm.variables.set(\"accountId\", account.id)","})"],"id":"2a8fe631-78f5-4660-914b-92b3a7f4c750"}}],"_postman_id":"dbe82c34-14e7-4136-b242-7482cb9087d8"},{"name":"Accounts (Simple)","item":[{"name":"Get Customer Accounts by Institution ID (Simple)","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equals(200)\r","})"],"type":"text/javascript","id":"cce87a27-7783-42be-9e0e-8403598f5ab0"}}],"id":"62aa2f89-f62b-44d6-b076-b1fa97791ff0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"default"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"default"}],"url":"https://api.finicity.com/aggregation/v1/customers/6025984717/institutions/{{institutionLoginId}}/accounts/simple","description":"This API is a lighter version of Get Customer Accounts by Institution ID, returning only basic information of active accounts owned by the given customer at the given institution.
\nSupported regions:
This API is a lighter version of Get Customer Accounts by Institution Login ID, returning only basic information of all active accounts owned by the given customer at the given institution login ID.
\nSupported regions:
This API is a lighter version of Get Customer Accounts by ID, returning only basic information of a customer account.
\nSupported regions:
This API is a lighter version of Get Customer Accounts, returning only basic information of all active customer accounts.
\nSupported regions:
Fetch simple customer accounts
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["const baseUrl = pm.collectionVariables.get(\"baseUrl\")","const appKey = pm.environment.get(\"appKey\")","const customerId = pm.environment.get(\"customerId\")","const appToken = pm.globals.get(\"appToken\")","","const institutionLoginId = pm.variables.get(\"institutionLoginId\")","const institutionId = pm.variables.get(\"institutionId\")","const accountId = pm.variables.get(\"accountId\")","if (institutionLoginId && institutionId && accountId) {"," return","}","","","console.log(\"Fetching account ID, institution ID and institution login ID ...\")","const options = {"," url: baseUrl + \"/aggregation/v1/customers/\"+ customerId + \"/accounts\","," method: 'GET',"," header: {"," \"Accept\": \"application/json\","," \"Finicity-App-Key\": appKey,"," \"Finicity-App-Token\": appToken"," }","}","pm.sendRequest(options, function (err, response) {"," pm.expect(err).to.be.null"," pm.expect(response.code).to.equals(200)"," const account = response.json().accounts[0]"," pm.variables.set(\"institutionLoginId\", account.institutionLoginId)"," pm.variables.set(\"institutionId\", account.institutionId)"," pm.variables.set(\"accountId\", account.id)","})"],"id":"d49a7fe0-bf1a-4f20-9dee-a9673d5b139c"}}],"_postman_id":"569a3920-cbc0-4add-9872-4d318c5acf79"},{"name":"App Registration","item":[{"name":"Register App","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equals(201)\r","})"],"type":"text/javascript","id":"ebedc921-bd3e-4ed5-897d-640dfa795f1e"}}],"id":"d814738b-8125-46fd-88ed-8012dcf63b91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{\n \"appDescription\": \"The app that makes your budgeting experience awesome\",\n \"appName\": \"Awesome Budget App_71d98183-990b-401d-99a6-ebcba599f962\",\n \"appUrl\": \"https://www.finicity.com/\",\n \"ownerAddressLine1\": \"434 W Ascension Way\",\n \"ownerAddressLine2\": \"Suite #200\",\n \"ownerCity\": \"Murray\",\n \"ownerCountry\": \"USA\",\n \"ownerName\": \"Finicity\",\n \"ownerPostalCode\": \"84123\",\n \"ownerState\": \"UT\",\n \"image\": \"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+CjxzdmcgICAKICAgeG1sbnM6c3ZnPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIKICAgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIgogICB2ZXJzaW9uPSIxLjEiCiAgIHZpZXdCb3g9IjAgMCAwIDAiCiAgIGhlaWdodD0iMCIKICAgd2lkdGg9IjAiPgogICAgPGcvPgo8L3N2Zz4K\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/aggregation/v1/partners/applications","description":"Register a new application to access financial institutions using OAuth connections.
\nSupported regions:
Update a registered application.
\nSupported regions:
Get the status of your application registration(s).
\nSupported regions:
The application registration tracking ID
\n","type":"text/plain"},"key":"preAppId","value":"2581"},{"disabled":true,"description":{"content":"The application ID
\n","type":"text/plain"},"key":"applicationId","value":"123456789"},{"disabled":true,"description":{"content":"Look up app registration requests by status
\n","type":"text/plain"},"key":"status","value":"P"},{"disabled":true,"description":{"content":"Look up app registration requests by app name
\n","type":"text/plain"},"key":"appName","value":"Awesome Budget App"},{"disabled":true,"description":{"content":"Look up app registration requests by the date they were submitted
\n","type":"text/plain"},"key":"submittedDate","value":"1607450357"},{"disabled":true,"description":{"content":"Look up app registration requests by the date the request was updated. This can be used to determine when a request was updated to \"A\" or \"R\".
\n","type":"text/plain"},"key":"modifiedDate","value":"1607450357"},{"disabled":true,"description":{"content":"Index of the page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Maximum number of results per page
\n","type":"text/plain"},"key":"pageSize","value":"20"}],"variable":[]}},"response":[{"id":"6ae35ca6-a980-4f56-9c9c-7bc21877484b","name":"The app registration statuses were returned","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v2/partners/applications?preAppId=2581&applicationId=123456789&status=P&appName=Awesome Budget App&submittedDate=1607450357&modifiedDate=1607450357&page=1&pageSize=20","host":["https://api.finicity.com"],"path":["aggregation","v2","partners","applications"],"query":[{"key":"preAppId","value":"2581"},{"key":"applicationId","value":"123456789"},{"key":"status","value":"P"},{"key":"appName","value":"Awesome Budget App"},{"key":"submittedDate","value":"1607450357"},{"key":"modifiedDate","value":"1607450357"},{"key":"page","value":"1"},{"key":"pageSize","value":"20"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"085d066b-391a-4016-9ac6-09fb473e5727","name":"The request was rejected","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v2/partners/applications?preAppId=2581&applicationId=123456789&status=P&appName=Awesome Budget App&submittedDate=1607450357&modifiedDate=1607450357&page=1&pageSize=20","host":["https://api.finicity.com"],"path":["aggregation","v2","partners","applications"],"query":[{"key":"preAppId","value":"2581"},{"key":"applicationId","value":"123456789"},{"key":"status","value":"P"},{"key":"appName","value":"Awesome Budget App"},{"key":"submittedDate","value":"1607450357"},{"key":"modifiedDate","value":"1607450357"},{"key":"page","value":"1"},{"key":"pageSize","value":"20"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"d244ebe8-7e15-4225-b594-e44ab0c25e66","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v2/partners/applications?preAppId=2581&applicationId=123456789&status=P&appName=Awesome Budget App&submittedDate=1607450357&modifiedDate=1607450357&page=1&pageSize=20","host":["https://api.finicity.com"],"path":["aggregation","v2","partners","applications"],"query":[{"key":"preAppId","value":"2581"},{"key":"applicationId","value":"123456789"},{"key":"status","value":"P"},{"key":"appName","value":"Awesome Budget App"},{"key":"submittedDate","value":"1607450357"},{"key":"modifiedDate","value":"1607450357"},{"key":"page","value":"1"},{"key":"pageSize","value":"20"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"84d1a51e-b162-4409-bfe3-a82805b06431","name":"The resource doesn't exist","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v2/partners/applications?preAppId=2581&applicationId=123456789&status=P&appName=Awesome Budget App&submittedDate=1607450357&modifiedDate=1607450357&page=1&pageSize=20","host":["https://api.finicity.com"],"path":["aggregation","v2","partners","applications"],"query":[{"key":"preAppId","value":"2581"},{"key":"applicationId","value":"123456789"},{"key":"status","value":"P"},{"key":"appName","value":"Awesome Budget App"},{"key":"submittedDate","value":"1607450357"},{"key":"modifiedDate","value":"1607450357"},{"key":"page","value":"1"},{"key":"pageSize","value":"20"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"}],"_postman_id":"8b3df70e-cff5-4d62-a3a8-9a239b797af2"},{"name":"Set Customer App ID","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," // \"invalid application id\"\r"," pm.expect(pm.response.code).to.equals(400)\r","})"],"type":"text/javascript","id":"9d6ce23e-b608-4bbe-a0a0-0f834d2e622d"}}],"id":"f1a2c89e-a05e-4b6f-bed0-23f38aa4800b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/aggregation/v1/customers/6025984717/applications/:applicationId","description":"If you have multiple applications for a single client, and you want to register their applications to access financial institutions using OAuth connections, then use this API to assign applications to an existing customer.
\nSupported regions:
The institutionLoginId parameter uses Finicity's internal FI mapping to move accounts from the current FI legacy connection to the new OAuth FI connection.
This API returns a list of accounts for the given institution login ID.
\nSupported regions:
Register and assign apps to customers
\n","_postman_id":"a515fd82-2051-4be2-8540-19de0d6ebfa5"},{"name":"Assets","item":[{"name":"Get Asset by Customer and ID","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equals(200)\r","})"],"type":"text/javascript","id":"a8b021a5-13bb-4b28-b897-a1d5861c4f4d"}},{"listen":"prerequest","script":{"exec":["const baseUrl = pm.collectionVariables.get(\"baseUrl\")\r","const appKey = pm.environment.get(\"appKey\")\r","const customerId = pm.environment.get(\"customerId\")\r","const appToken = pm.globals.get(\"appToken\")\r","\r","const assetId = pm.variables.get(\"assetId\")\r","if (assetId) {\r"," return\r","}\r","\r","console.log(\"Creating asset ID ...\")\r","const options = {\r"," url: baseUrl + \"/aggregation/v1/customers/\"+ customerId + \"/payStatements\",\r"," method: 'POST',\r"," header: {\r"," \"Accept\": \"application/json\",\r"," \"Content-Type\": \"application/json\",\r"," \"Finicity-App-Key\": appKey,\r"," \"Finicity-App-Token\": appToken\r"," },\r"," body: JSON.stringify({\r"," \"label\": \"lastPayPeriod\",\r"," \"statement\": \"VGhpcyBtdXN0IGJlIGFuIGltYWdl\"\r"," })\r","}\r","pm.sendRequest(options, function (err, response) {\r"," pm.expect(err).to.be.null\r"," pm.expect(response.code).to.equals(200)\r"," pm.variables.set(\"assetId\", response.json().assetId)\r","})"],"type":"text/javascript","id":"9e7a2725-8267-409c-aefb-642bd3b6e6c0"}}],"id":"e56a5e79-c8ec-4ba2-a9f4-6421244951d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"}],"url":"https://api.finicity.com/aggregation/v1/customers/6025984717/assets/{{assetId}}","description":"Retrieve a binary file for the given asset ID.
\nSupported regions:
Download asset files
\n","_postman_id":"4d7028c3-42bf-4f32-be28-01ef6ac370db"},{"name":"Authentication","item":[{"name":"Create Access Token","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equals(200)\r","})"],"type":"text/javascript","id":"e65e543b-0a26-41f1-af66-5589e275c555"}}],"id":"426c2db4-0e41-4cd9-a8fa-c057113a8e3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partnerId\": \"2445584195057\",\n \"partnerSecret\": \"Xb0dkA6h9fXn5gqLkfrI\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/aggregation/v2/partners/authentication","description":"Send Partner ID and Partner Secret to the Partner Authentication service to obtain a token for accessing Finicity APIs.
\nSupported regions:
Change the Partner Secret used to authenticate this partner.
\nThe secret does not expire, but can be changed by calling this API. A valid Partner Secret may contain upper and lowercase characters, numbers, and the characters !, @, #, $, %, &, *, _, -, +. It must include at least one number and at least one letter, and its length should be between 12 and 255 characters.
\nSupported regions:
Generate authentication tokens and manage credentials
\n","_postman_id":"379a0724-e25a-4e3b-b4a5-d25337b12668"},{"name":"Balance Analytics","item":[{"name":"Generate Balance Analytics","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equals(200)\r","\r"," /* Store the report ID */\r"," const reportId = pm.response.json().reportId\r"," pm.globals.set(\"obbReportId\", reportId)\r","})"],"type":"text/javascript","id":"23b9da9f-6646-4479-af85-6af55491e01c"}}],"id":"bcdcf0f4-5b69-4db3-b3d3-ee1a13051dbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/analytics/balance/v1/customer/6025984717?reference-number=abc123","description":"Balance Analytics for Business analyzes bank balances over time to report metrics and identify behavior that may indicate risk.
\nCalculated metrics include:
\nCurrent/available account balances
\nMinimum/maximum/average account balances over the requested time\nperiod and broken down by month
\nDaily ending balance of accounts for each day in the requested time\nperiod
\nPropensity of the customer's account balances to increase week over\nweek
\nNumber of days in the requested time period ending with a negative\nbalance
\nThis version of the API is intended for piloting and integration testing your application with the Balance Analytics product. It does not adhere to FCRA requirements, and should not be used for production/lending purposes. See Generate Balance Analytics - FCRA for the FCRA compliant version of this API.
\nA successful call to this API will generate analytics and store a report within Finicity. The report can be retrieved via Get Balance Analytics Report (operation: GetObbAnalyticsReport).
\nSupported regions:
Partner-provided reference number to correlate reports.
\n","type":"text/plain"},"key":"reference-number","value":"abc123"}],"variable":[]}},"response":[{"id":"df58b880-7a87-4509-8ee0-3aa0958cee8d","name":"Response given when balance analytics were generated successfully, providing the caller with a report ID which can be used to retrieve the report as JSON or a PDF.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"Balance Analytics for Business analyzes bank balances over time to report metrics and identify behavior that may indicate risk.
\nCalculated metrics include:
\nCurrent/available account balances
\nMinimum/maximum/average account balances over the requested time\nperiod and broken down by month
\nDaily ending balance of accounts for each day in the requested time\nperiod
\nPropensity of the customer's account balances to increase week over\nweek
\nNumber of days in the requested time period ending with a negative\nbalance
\nThis version of the API is intended for production use. It maintains and enforces all compliance with FCRA rules and requirements.
\nNote: this is a premium service, billable per every successful API call for non-testing customers.
\nA successful call to this API will generate analytics and store a report within Finicity. The report can be retrieved via Get Balance Analytics Report - FCRA (operation: GetObbAnalyticsReportFCRA).
\nSupported regions:
Partner-provided reference number to correlate reports.
\n","type":"text/plain"},"key":"reference-number","value":"abc123"}],"variable":[]}},"response":[{"id":"f10576c8-006f-45e5-8022-b697a7408436","name":"Response given when balance analytics (FCRA) were generated successfully, providing the caller with a report ID which can be used to retrieve the report as JSON or a PDF.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"Retrieve the report saved by Generate Balance Analytics or Generate Cash Flow Analytics. Requires the report ID generated by the previous call.
\nReport data can either be retrieved as a JSON document or PDF file.
\nSupported regions:
Retrieve the report saved by Generate Balance Analytics - FCRA or Generate Cash Flow Analytics - FCRA. Requires the report ID generated by the previous call.
\nReport data can either be retrieved as a JSON document or PDF file.
\nNote: this is a premium service, billable per every successful API call for non-testing customers.
\nSupported regions:
(Required) 2-digit code from Permissible Purpose Codes, specifying the reason for retrieving this report. Required for retrieving some reports.
\n","type":"text/plain"},"key":"purpose","value":"proident esse deserunt adipisicing"}],"variable":[]}},"response":[{"id":"c86fe56f-5072-4d01-a1cb-a3d569193662","name":"OBB Analytics FCRA report data as JSON or PDF","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"Balance Analytics for businesses
\n","_postman_id":"f47fcc3a-3ec5-4ceb-b66e-45f551df26e3"},{"name":"Bank Statements","item":[{"name":"Get Customer Account Statement","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equal(200)\r","})"],"type":"text/javascript","id":"9906949a-ea7f-4b66-bca7-a467bce7f02b"}}],"id":"55ffba75-0643-4bd8-9bd6-99ba02fba85e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"}],"url":"https://api.finicity.com/aggregation/v1/customers/6025984717/accounts/{{accountId}}/statement?index=1","description":"Retrieve the customer's bank statements in PDF format. Up to 24 months of history is available depending on the financial institution. Since this is a premium service, charges incur per each successful statement retrieved.
\nFor certified financial institutions, statements are available for the following account types:
\nNote: setting the timeout to 180 seconds is recommended to allow enough time for a response.
\nSupported regions:
Request statements from 1-24. By default, 1 is the most recent statement. Increase the index value to count back (by month) and retrieve its most recent statement.
\n","type":"text/plain"},"key":"index","value":"1"},{"disabled":true,"description":{"content":"The type of statement to retrieve
\n","type":"text/plain"},"key":"type","value":"taxStatement"}],"variable":[]}},"response":[{"id":"4ccc87f1-e2c0-4fda-a07e-c56c0d1c3c91","name":"The statement was successfully downloaded as a PDF file","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v1/customers/:customerId/accounts/:accountId/statement?index=1","host":["https://api.finicity.com"],"path":["aggregation","v1","customers",":customerId","accounts",":accountId","statement"],"query":[{"key":"index","value":"1"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"},{"key":"accountId","value":"5011648377","description":"(Required) The account ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/octet-stream"}],"cookie":[],"responseTime":null,"body":""},{"id":"1dcf7154-0f4b-4110-b086-aa5834801af4","name":"The response contains an MFA challenge in XML or JSON format. Contact your Account Manager or Systems Engineers to determine the best route to handle this error.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v1/customers/:customerId/accounts/:accountId/statement?index=1","host":["https://api.finicity.com"],"path":["aggregation","v1","customers",":customerId","accounts",":accountId","statement"],"query":[{"key":"index","value":"1"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"},{"key":"accountId","value":"5011648377","description":"(Required) The account ID"}]}},"status":"Non-Authoritative Information (since HTTP/1.1)","code":203,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"e05bbdd2-aee6-4b37-9242-10f0ad19909a","name":"The request was rejected","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v1/customers/:customerId/accounts/:accountId/statement?index=1","host":["https://api.finicity.com"],"path":["aggregation","v1","customers",":customerId","accounts",":accountId","statement"],"query":[{"key":"index","value":"1"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"},{"key":"accountId","value":"5011648377","description":"(Required) The account ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"5918e6d2-fda3-4b07-91d7-6f9086edead9","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v1/customers/:customerId/accounts/:accountId/statement?index=1","host":["https://api.finicity.com"],"path":["aggregation","v1","customers",":customerId","accounts",":accountId","statement"],"query":[{"key":"index","value":"1"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"},{"key":"accountId","value":"5011648377","description":"(Required) The account ID"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"52c56a1e-232e-4101-9993-06e2ce46e90d","name":"The resource doesn't exist","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v1/customers/:customerId/accounts/:accountId/statement?index=1","host":["https://api.finicity.com"],"path":["aggregation","v1","customers",":customerId","accounts",":accountId","statement"],"query":[{"key":"index","value":"1"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"},{"key":"accountId","value":"5011648377","description":"(Required) The account ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"}],"_postman_id":"55ffba75-0643-4bd8-9bd6-99ba02fba85e"},{"name":"Generate Statement Report","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([202, 429, 401])\r","})"],"type":"text/javascript","id":"0d53d6f9-54c1-46f5-a13f-aa2cdd8a64c6"}},{"listen":"prerequest","script":{"exec":["const baseUrl = pm.collectionVariables.get(\"baseUrl\")\r","const customerId = pm.environment.get(\"customerId\")\r","const appKey = pm.environment.get(\"appKey\")\r","const appToken = pm.globals.get(\"appToken\")\r","\r","// A consumer is needed for this API\r","createConsumer()\r","\t\r","function createConsumer() {\r"," const consumerExists = pm.globals.get(\"consumerExists\")\r"," if (consumerExists) {\r"," // A consumer was already created\r"," return\r"," }\r","\r"," console.log(\"Creating consumer ... \")\r"," const options = {\r"," url: baseUrl + \"/decisioning/v1/customers/\" + customerId + \"/consumer\", \r"," method: 'POST',\r"," header: {\r"," \"Accept\": \"application/json\",\r"," \"Content-type\": \"application/json\",\r"," \"Finicity-App-Key\": appKey,\r"," \"Finicity-App-Token\": appToken\r"," },\r"," body: JSON.stringify({\r"," \"firstName\": \"Homer\",\r"," \"lastName\": \"Loanseeke\",\r"," \"address\": \"434 W Ascension Way\",\r"," \"city\": \"Murray\",\r"," \"state\": \"UT\",\r"," \"zip\": \"84123\",\r"," \"phone\": \"1-800-986-3343\",\r"," \"ssn\": \"999601111\",\r"," \"birthday\": {\r"," \"year\": 1970,\r"," \"month\": 7,\r"," \"dayOfMonth\": 4\r"," },\r"," \"email\": \"finicity@test.com\",\r"," \"suffix\": \"Mr\"\r"," })\r"," }\r"," pm.sendRequest(options, function (err, response) {\r"," pm.expect(err).to.be.null\r"," pm.expect(response.code).to.be.oneOf([200, 201, 409])\r"," pm.globals.set(\"consumerExists\", true)\r"," })\r","}"],"type":"text/javascript","id":"6742b077-5cdb-4c2c-b2e0-b560ca18d674"}}],"id":"5db193fd-2fad-42d5-81f6-3a02f7d30792","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{\n \"statementReportData\": {\n \"accountId\": {{accountId}},\n \"index\": 1\n },\n \"reportCustomFields\": [\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n },\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/decisioning/v2/customers/6025984717/statement","description":"Generate a Statement Report report for the given accounts under the given customer.
\nThis is a premium service. A billable event will be created upon the successful generation of the Statement Report.
\nBefore calling this API, a consumer must be created for the given customer ID (see Consumers APIs).
\nSupported regions:
A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code.
\n","type":"text/plain"},"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[]}},"response":[{"id":"fef2f820-ed16-4932-80ed-f0e6cb71967e","name":"The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/statement?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","statement"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"67c94f97-270f-4089-b1ca-028780113659","name":"The request was rejected","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/statement?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","statement"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"72c526fc-9e62-4c83-8d95-aad680570e06","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/statement?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","statement"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"93d34205-f1d6-414a-8eb9-e8e890e5b216","name":"The resource doesn't exist","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/statement?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","statement"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"}],"_postman_id":"5db193fd-2fad-42d5-81f6-3a02f7d30792"}],"id":"101afbc8-12c0-4052-aede-249c67c7668f","description":"Fetch account statements and generate reports asynchronously
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["const baseUrl = pm.collectionVariables.get(\"baseUrl\")","const appKey = pm.environment.get(\"appKey\")","const customerId = pm.environment.get(\"customerId\")","const appToken = pm.globals.get(\"appToken\")","","const accountId = pm.variables.get(\"accountId\")","if (accountId) {"," return","}","","console.log(\"Fetching account ID ...\")","const options = {"," url: baseUrl + \"/aggregation/v1/customers/\"+ customerId + \"/accounts\","," method: 'GET',"," header: {"," \"Accept\": \"application/json\","," \"Finicity-App-Key\": appKey,"," \"Finicity-App-Token\": appToken"," }","}","pm.sendRequest(options, function (err, response) {"," pm.expect(err).to.be.null"," pm.expect(response.code).to.equals(200)"," pm.variables.set(\"accountId\", response.json().accounts[0].id)","})"],"id":"7a7bf9f0-df60-4edd-8ca4-ce950993ec07"}}],"_postman_id":"101afbc8-12c0-4052-aede-249c67c7668f"},{"name":"Cash Flow","item":[{"name":"Generate Cash Flow Report - Business","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([202, 429, 401])\r","})"],"type":"text/javascript","id":"22b56660-10b3-4136-a8ec-ea020c096e16"}}],"id":"c3f142e9-38d4-4f42-87c6-cfae71eb9548","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportCustomFields\": [\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n },\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n }\n ],\n \"showNsf\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/decisioning/v2/customers/6025984717/cashFlowBusiness","description":"Generate a Cash Flow Report (Business) report for all checking and savings under the given customer. This service retrieves up to two years of transaction history for the given account. It then uses this information to generate the CFR report. A consumer is not required to generate this report.
\nThis report is not provided under FCRA rules, and this report is not available in the Finicity Consumer Portal for the borrower to view.
\nIf no account type of checking or savings is found, the service will return HTTP 400 Bad Request.
\nSupported regions:
A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code.
\n","type":"text/plain"},"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[]}},"response":[{"id":"eacf5dd7-e9bc-4aaf-93a3-9a72d41766cb","name":"The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/cashFlowBusiness?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","cashFlowBusiness"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"e45634bc-b9d5-4990-afff-15e11d5790f8","name":"The request was rejected","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/cashFlowBusiness?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","cashFlowBusiness"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"729adb8d-02f1-45de-8d50-560ce8620f9f","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/cashFlowBusiness?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","cashFlowBusiness"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"cc32bd90-19df-42c9-8adc-16438f186819","name":"The resource doesn't exist","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/cashFlowBusiness?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","cashFlowBusiness"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"}],"_postman_id":"c3f142e9-38d4-4f42-87c6-cfae71eb9548"},{"name":"Generate Cash Flow Report - Personal","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([202, 429, 401])\r","})"],"type":"text/javascript","id":"1fbacf40-0106-44d7-b361-e0d4814e19dd"}}],"id":"5df434a9-eb08-43f2-b1a5-68d4ea7ed15c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportCustomFields\": [\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n },\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n }\n ],\n \"showNsf\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/decisioning/v2/customers/6025984717/cashFlowPersonal","description":"Generate a Cash Flow Report (Personal) report for all checking and savings under the given customer. This service retrieves up to two years of transaction history for the given account. It then uses this information to generate the CFR report.
\nThis report is provided under FCRA rules, with Finicity acting as the CRA (Consumer Reporting Agency). If an individual account is included in the report - for example, with an individual acting as an personal guarantor on the loan - then this version of the report should be used. In case of an adverse action on the loan where the decision was based on this report, then the borrower can be referred to the Finicity Consumer Portal where they can view this report and submit a dispute if they feel any information in this report is inaccurate.
\nBefore calling this API, a consumer must be created for the given customer ID (see Consumers APIs).
\nIf no account type of checking or savings is found, the service will return HTTP 400 Bad Request.
\nSupported regions:
A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code.
\n","type":"text/plain"},"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[]}},"response":[{"id":"541980bb-9d99-4ad2-ba87-ea7d89bbfc95","name":"The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/cashFlowPersonal?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","cashFlowPersonal"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"fdb8fcde-df37-424c-8870-09b43d37e5ab","name":"The request was rejected","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/cashFlowPersonal?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","cashFlowPersonal"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"b0fa09f3-7aab-4740-bb18-d47989c8e99e","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/cashFlowPersonal?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","cashFlowPersonal"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"c33e6c05-2b64-4f05-a0e0-7e9efdd356ce","name":"The resource doesn't exist","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/cashFlowPersonal?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","cashFlowPersonal"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"}],"_postman_id":"5df434a9-eb08-43f2-b1a5-68d4ea7ed15c"}],"id":"9c92a374-8191-4b95-97b7-1297522f11cb","description":"Generate cash flow reports asynchronously
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["// A consumer is needed for these APIs","createConsumer()","\t","function createConsumer() {"," const baseUrl = pm.collectionVariables.get(\"baseUrl\")"," const customerId = pm.environment.get(\"customerId\")"," const appKey = pm.environment.get(\"appKey\")"," const appToken = pm.globals.get(\"appToken\")",""," const consumerExists = pm.globals.get(\"consumerExists\")"," if (consumerExists) {"," // A consumer was already created"," return"," }",""," console.log(\"Creating consumer ... \")"," const options = {"," url: baseUrl + \"/decisioning/v1/customers/\" + customerId + \"/consumer\", "," method: 'POST',"," header: {"," \"Accept\": \"application/json\","," \"Content-type\": \"application/json\","," \"Finicity-App-Key\": appKey,"," \"Finicity-App-Token\": appToken"," },"," body: JSON.stringify({"," \"firstName\": \"Homer\","," \"lastName\": \"Loanseeke\","," \"address\": \"434 W Ascension Way\","," \"city\": \"Murray\","," \"state\": \"UT\","," \"zip\": \"84123\","," \"phone\": \"1-800-986-3343\","," \"ssn\": \"999601111\","," \"birthday\": {"," \"year\": 1970,"," \"month\": 7,"," \"dayOfMonth\": 4"," },"," \"email\": \"finicity@test.com\","," \"suffix\": \"Mr\""," })"," }"," pm.sendRequest(options, function (err, response) {"," pm.expect(err).to.be.null"," pm.expect(response.code).to.be.oneOf([200, 201, 409])"," pm.globals.set(\"consumerExists\", true)"," })","}"],"id":"e8e13dcb-a4e4-4039-bb77-469974285196"}}],"_postman_id":"9c92a374-8191-4b95-97b7-1297522f11cb"},{"name":"Cash Flow Analytics","item":[{"name":"Generate Cash Flow Analytics","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equals(200)\r","\r"," /* Store the report ID */\r"," const reportId = pm.response.json().reportId\r"," pm.globals.set(\"obbReportId\", reportId)\r","})"],"type":"text/javascript","id":"346a8bcc-c9c1-4997-bafc-31e21bcab1ab"}}],"id":"d55f352b-8cde-4192-9163-9f33318e01a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/analytics/cashflow/v1/customer/6025984717?reference-number=abc123","description":"Cash Flow Analytics for Business analyzes cash flow over time to report metrics and identify behavior that may indicate risk.
\nCalculated metrics include:
\nAverage transaction value by month over the requested time period
\nNet cash flow over the requested time period and broken down by month
\nCount and report of weeks in the requested time period where there\nwere zero transactions posted to the customer's accounts
\nMinimum/maximum/average/sum/count of deposits by month
\nMinimum/maximum/average/sum/count of withdrawals by month
\nEstimated amount of deposits that can be classified as business\nrevenue
\nNumber of transactions posted incurring a non-sufficient funds (NSF)\nfee, and net amount charged in NSF fees
\nThis version of the API is intended for piloting and integration testing your application with the Cash Flow Analytics product. It does not adhere to FCRA requirements, and should not be used for production/lending purposes. See Generate Cash Flow Analytics - FCRA for the FCRA compliant version of this API.
\nA successful call to this API will generate analytics and store a report within Finicity. The report can be retrieved via Get Cash Flow Analytics Report (operation: GetCashFlowAnalyticsReport).
\nSupported regions:
Partner-provided reference number to correlate reports.
\n","type":"text/plain"},"key":"reference-number","value":"abc123"}],"variable":[]}},"response":[{"id":"f46dbcbc-f030-4159-8b46-5ba7680589d3","name":"Response given when cash flow analytics were generated successfully, providing the caller with a report ID which can be used to retrieve the report as JSON or a PDF.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"Cash Flow Analytics for Business analyzes cash flow over time to report metrics and identify behavior that may indicate risk.
\nCalculated metrics include:
\nAverage transaction value by month over the requested time period
\nNet cash flow over the requested time period and broken down by month
\nCount and report of weeks in the requested time period where there\nwere zero transactions posted to the customer's accounts
\nMinimum/maximum/average/sum/count of deposits by month
\nMinimum/maximum/average/sum/count of withdrawals by month
\nEstimated amount of deposits that can be classified as business\nrevenue
\nNumber of transactions posted incurring a non-sufficient funds (NSF)\nfee, and net amount charged in NSF fees
\nThis version of the API is intended for production use. It maintains and enforces all compliance with FCRA rules and requirements.
\nNote: this is a premium service, billable per every successful API call for non-testing customers.
\nA successful call to this API will generate analytics and store a report within Finicity. The report can be retrieved via Get Cash Flow Analytics Report - FCRA (operation: GetCashFlowAnalyticsReportFCRA).
\nSupported regions:
Partner-provided reference number to correlate reports.
\n","type":"text/plain"},"key":"reference-number","value":"abc123"}],"variable":[]}},"response":[{"id":"b80690b1-8b42-4cca-9d86-b516d2a080bb","name":"Response given when cash flow analytics (FCRA) were generated successfully, providing the caller with a report ID which can be used to retrieve the report as JSON or a PDF.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"Retrieve the report saved by Generate Balance Analytics or Generate Cash Flow Analytics. Requires the report ID generated by the previous call.
\nReport data can either be retrieved as a JSON document or PDF file.
\nSupported regions:
Retrieve the report saved by Generate Balance Analytics - FCRA or Generate Cash Flow Analytics - FCRA. Requires the report ID generated by the previous call.
\nReport data can either be retrieved as a JSON document or PDF file.
\nNote: this is a premium service, billable per every successful API call for non-testing customers.
\nSupported regions:
(Required) 2-digit code from Permissible Purpose Codes, specifying the reason for retrieving this report. Required for retrieving some reports.
\n","type":"text/plain"},"key":"purpose","value":"proident esse deserunt adipisicing"}],"variable":[]}},"response":[{"id":"c22dc927-91f0-449f-98fb-121d00354028","name":"OBB Analytics FCRA report data as JSON or PDF","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"Cash Flow Analytics for business
\n","_postman_id":"6d42202f-ecf6-4e54-a412-67c6530b5dda"},{"name":"Connect π","item":[{"name":"Generate Connect URL","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equals(200)\r","})"],"type":"text/javascript","id":"3fe0c9a9-1bff-41cb-9fb0-41bb92338766"}}],"id":"adf5d88b-ebd2-4b53-8888-782353edcc38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partnerId\": \"2445584195057\",\n \"customerId\": \"6025984717\",\n \"language\": \"en\",\n \"consumerId\": \"0bf46322c167b562e6cbed9d40e19a4c\",\n \"redirectUri\": \"https://www.finicity.com/connect/\",\n \"webhookContentType\": \"application/json\",\n \"webhookData\": {},\n \"webhookHeaders\": {},\n \"optionalConsumerInfo\": {\n \"ssn\": \"999999999\",\n \"dob\": 1607450357\n },\n \"singleUseUrl\": true,\n \"institutionSettings\": {},\n \"fromDate\": 1607450357,\n \"reportCustomFields\": [\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n },\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/connect/v2/generate","description":"Generate a Connect 2.0 URL link to add within your own applications.
\nIn option, use the experience parameter to call Connect (per session) in the body of the request. Configure the experience parameter to change the brand color, logo, icon, which credit decisioning report to generate when the Connect application completes, and more.
Note: contact your Sales Account Team to set up the experience parameter.
MVS Developers: You can pre-populate the consumer's SSN on the \"Find employment records\" page at the beginning of the MVS payroll app. Pass the SSN value for the consumer in the body of the request call.
\nSupported regions:
Connect Lite is a variation of Connect Full (POST /connect/v2/generate), which has a limited set of features.
The Connect Web SDK isn't a requirement when using Connect lite. However, if you want to use the SDK events, routes, and user events, then you must integrate with the Connect Web SDK.
\nSupported regions:
Use the Connect Fix API when the following conditions occur:
\nSupported regions:
Same as Connect Full (POST /connect/v2/generate) but send a Connect email to a consumer.
Supported regions:
Same as Connect Full (POST /connect/v2/generate) but for joint borrowers.
MVS prompts both the primary and joint borrower to enter each of their financial, payroll, and paystub information in the same Connect session.
\nSupported regions:
Same as Connect Joint Borrower (POST /connect/v2/generate/jointBorrower) but send a Connect email to at least one of the joint borrower's email addresses.
When the consumer opens the email, MVS prompts both the primary and joint borrower to enter each of their financial, payroll, and paystub information in the same Connect session.
\nSupported regions:
Allow customers to log into their financial institutions and grant Finicity authorization
\n","_postman_id":"8f641000-2294-4637-ac7d-353fd9b182c4"},{"name":"Consumers","item":[{"name":"Create Consumer","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," // \"A consumer already exists for customer 5025024821\"\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201, 409])\r","})"],"type":"text/javascript","id":"0f128154-ef23-4739-aadd-205b15ab1dc6"}}],"id":"c492d66f-0ef6-4ccf-8132-30e830fea7ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Homer\",\n \"lastName\": \"Loanseeke\",\n \"address\": \"434 W Ascension Way\",\n \"city\": \"Murray\",\n \"state\": \"UT\",\n \"zip\": \"84123\",\n \"phone\": \"1-800-986-3343\",\n \"ssn\": \"999601111\",\n \"birthday\": {\n \"year\": 1970,\n \"month\": 7,\n \"dayOfMonth\": 4\n },\n \"email\": \"finicity@test.com\",\n \"suffix\": \"Mr\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/decisioning/v1/customers/6025984717/consumer","description":"Create a consumer record associated with the given customer. A consumer persists as the owner of any reports that are generated, even after the original customer is deleted from the system.
\nA consumer must be created for the given customer before calling any of the Generate Report services.
\nSupported regions:
Get the details of a consumer record by customer ID.
\nSupported regions:
Get the details of a consumer record by consumer ID.
\nSupported regions:
Modify an existing consumer. All fields are required for a consumer record, but individual fields for this call are optional because fields that are not specified will be left unchanged.
\nSupported regions:
Create and manage consumers associated with customers in order to use report services
\n","_postman_id":"b35553ed-cb9e-409a-9e66-6413e9595f11"},{"name":"Customers","item":[{"name":"Add Testing Customer","event":[{"listen":"test","script":{"exec":["const baseUrl = pm.collectionVariables.get(\"baseUrl\")\r","const appKey = pm.environment.get(\"appKey\")\r","const appToken = pm.globals.get(\"appToken\")\r","\r","pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equals(201)\r","})\r","\r","if (pm.response.code !== 201) {\r"," // Nothing to do\r"," return\r","}\r","\r","console.log(\"Request successful. Deleting created customer ...\")\r","const options = {\r"," url: baseUrl + \"/aggregation/v1/customers/\" + pm.response.json().id, \r"," method: 'DELETE',\r"," header: {\r"," \"Accept\": \"application/json\",\r"," \"Finicity-App-Key\": appKey,\r"," \"Finicity-App-Token\": appToken\r"," }\r","}\r","pm.sendRequest(options, function (err, response) {\r"," pm.test(\"Clean-up\", function () {\r"," pm.expect(err).to.be.null\r"," pm.expect(response.code).to.equal(204)\r"," })\r","})"],"type":"text/javascript","id":"11ef4f5a-8bec-4398-bec7-4af76fb2a4f4"}}],"id":"f703f902-f5ee-4936-8f52-595652e1b22c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\": \"customer_1778507251\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/aggregation/v2/customers/testing","description":"Enroll a testing customer (Test Drive accounts).
\nFor using testing customers with FinBank OAuth, you must register a test application with your systems engineer or account manager. Then, use that testing applicationId when creating testing customers.
Testing Customers can access FinBank profiles (except \"FinBank Billable\" profiles), and cannot access live financial institutions.
\nSupported regions:
Enroll an active customer, which is the actual owner of one or more real-world accounts. This is a billable customer.
\nActive customers must use the \"FinBank Billable\" profiles for testing purposes.
\nSupported regions:
Find all customers enrolled by the current partner, where the search text is found in the customer's username or any combination of firstName and lastName fields. If no search text is provided, all customers will be returned.
Supported regions:
Username for exact match (will return 0 or 1 record)
\n","type":"text/plain"},"key":"username","value":""},{"description":{"content":"\"testing\" or \"active\" to return only customers of that type, or leave empty to return all customers
\n","type":"text/plain"},"key":"type","value":""},{"description":{"content":"The text you wish to match. Leave this empty if you wish to return all customers. Must be URL-encoded (see: Handling Spaces in Queries).
\n","type":"text/plain"},"key":"search","value":""},{"description":{"content":"Index of the page of results to return
\n","type":"text/plain"},"key":"start","value":"1"},{"description":{"content":"Maximum number of results per page
\n","type":"text/plain"},"key":"limit","value":"25"}],"variable":[]}},"response":[{"id":"07fdd30c-06b9-417a-a9a9-9013ec6d8089","name":"Customers were successfully retrieved","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v1/customers?username=customerusername1&type=active&search=searchvalue&start=1&limit=25","host":["https://api.finicity.com"],"path":["aggregation","v1","customers"],"query":[{"key":"username","value":"customerusername1"},{"key":"type","value":"active"},{"key":"search","value":"searchvalue"},{"key":"start","value":"1"},{"key":"limit","value":"25"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"58155399-1d26-4a4b-8604-65be13641c8b","name":"The request was rejected","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v1/customers?username=customerusername1&type=active&search=searchvalue&start=1&limit=25","host":["https://api.finicity.com"],"path":["aggregation","v1","customers"],"query":[{"key":"username","value":"customerusername1"},{"key":"type","value":"active"},{"key":"search","value":"searchvalue"},{"key":"start","value":"1"},{"key":"limit","value":"25"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"4d519761-7c20-4a57-a0c1-06eac3d459e5","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v1/customers?username=customerusername1&type=active&search=searchvalue&start=1&limit=25","host":["https://api.finicity.com"],"path":["aggregation","v1","customers"],"query":[{"key":"username","value":"customerusername1"},{"key":"type","value":"active"},{"key":"search","value":"searchvalue"},{"key":"start","value":"1"},{"key":"limit","value":"25"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"}],"_postman_id":"4187601f-85ae-4189-8c3c-0465ab72eb67"},{"name":"Get Customer With App Data by ID","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," // No registered partner applications found\r"," pm.expect(pm.response.code).to.equals(404)\r","})"],"type":"text/javascript","id":"ccbad593-22da-40da-9dc9-321f5490238c"}}],"id":"c1fcf721-4413-46e4-949c-e59d24b8e650","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.finicity.com/aggregation/v1/customers/6025984717/application","description":"Retrieve a customer along with additional details about the OAuth application.
\nSupported regions:
Retrieve a customer by ID.
\nSupported regions:
Modify an enrolled customer by ID.
\nYou must specify either firstName, lastName, or both in the request.
Supported regions:
Completely remove a customer from the system. This will remove the customer and all associated accounts and transactions.
\nβ οΈ Use this service carefully! It will not pause for confirmation before performing the operation!
\nSupported regions:
Enroll and manage customers
\n","_postman_id":"560db0d5-1dab-464d-9cc6-be7e3332c74b"},{"name":"Institutions","item":[{"name":"Get Certified Institutions With RSSD","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equals(200)\r","})"],"type":"text/javascript","id":"428449a3-8242-49df-99ea-57e6835b8e02"}}],"id":"88e3d0e1-ff20-4302-b8fa-0b96599f8139","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"}],"url":"https://api.finicity.com/institution/v2/certifiedInstitutions/rssd?search=finbank&start=1&limit=25&type=voa","description":"Search for certified financial institutions w/RSSD.
\nSupported regions:
Search term (financial institution name field). Leave empty for all FIs.
Index of the page of results to return
\n","type":"text/plain"},"key":"start","value":"1"},{"description":{"content":"Maximum number of results per page
\n","type":"text/plain"},"key":"limit","value":"25"},{"description":{"content":"A product type: \"transAgg\", \"ach\", \"stateAgg\", \"voi\", \"voa\", \"aha\", \"availBalance\", \"accountOwner\"
\n","type":"text/plain"},"key":"type","value":"voa"}],"variable":[]}},"response":[{"id":"11fb8b57-e9ac-40ca-9c03-713fd583f691","name":"Institutions were successfully retrieved","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/institution/v2/certifiedInstitutions/rssd?search=finbank&start=1&limit=25&type=voa","host":["https://api.finicity.com"],"path":["institution","v2","certifiedInstitutions","rssd"],"query":[{"key":"search","value":"finbank"},{"key":"start","value":"1"},{"key":"limit","value":"25"},{"key":"type","value":"voa"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"e2dca695-3179-45ed-be7a-903f9d129328","name":"The request was rejected","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/institution/v2/certifiedInstitutions/rssd?search=finbank&start=1&limit=25&type=voa","host":["https://api.finicity.com"],"path":["institution","v2","certifiedInstitutions","rssd"],"query":[{"key":"search","value":"finbank"},{"key":"start","value":"1"},{"key":"limit","value":"25"},{"key":"type","value":"voa"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"5d9696dd-b0df-4af7-bfa1-4aca7dea4714","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/institution/v2/certifiedInstitutions/rssd?search=finbank&start=1&limit=25&type=voa","host":["https://api.finicity.com"],"path":["institution","v2","certifiedInstitutions","rssd"],"query":[{"key":"search","value":"finbank"},{"key":"start","value":"1"},{"key":"limit","value":"25"},{"key":"type","value":"voa"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"}],"_postman_id":"88e3d0e1-ff20-4302-b8fa-0b96599f8139"},{"name":"Get Institutions","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equals(200)\r","})"],"type":"text/javascript","id":"2109d86b-5005-4ebe-9b46-01d97cd6cbb2"}}],"id":"ae91d997-31d9-45c2-83d3-98a72b588d4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"}],"url":"https://api.finicity.com/institution/v2/institutions?search=finbank&start=1&limit=25&type=voa","description":"Search for financial institutions.
\nSupported regions:
Search term (financial institution name field). Leave empty for all FIs.
Index of the page of results to return
\n","type":"text/plain"},"key":"start","value":"1"},{"description":{"content":"Maximum number of results per page
\n","type":"text/plain"},"key":"limit","value":"25"},{"description":{"content":"A product type: \"transAgg\", \"ach\", \"stateAgg\", \"voi\", \"voa\", \"aha\", \"availBalance\", \"accountOwner\"
\n","type":"text/plain"},"key":"type","value":"voa"}],"variable":[]}},"response":[{"id":"a7faa554-ace2-4537-9401-7db6b2ac8af6","name":"Institutions were successfully retrieved","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/institution/v2/institutions?search=finbank&start=1&limit=25&type=voa","host":["https://api.finicity.com"],"path":["institution","v2","institutions"],"query":[{"key":"search","value":"finbank"},{"key":"start","value":"1"},{"key":"limit","value":"25"},{"key":"type","value":"voa"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"49afbf1f-6e5e-4247-bd65-1391e60736cd","name":"The request was rejected","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/institution/v2/institutions?search=finbank&start=1&limit=25&type=voa","host":["https://api.finicity.com"],"path":["institution","v2","institutions"],"query":[{"key":"search","value":"finbank"},{"key":"start","value":"1"},{"key":"limit","value":"25"},{"key":"type","value":"voa"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"032e2493-9938-4c5f-86a4-5e68fb96e5e1","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/institution/v2/institutions?search=finbank&start=1&limit=25&type=voa","host":["https://api.finicity.com"],"path":["institution","v2","institutions"],"query":[{"key":"search","value":"finbank"},{"key":"start","value":"1"},{"key":"limit","value":"25"},{"key":"type","value":"voa"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"}],"_postman_id":"ae91d997-31d9-45c2-83d3-98a72b588d4f"},{"name":"Get Certified Institutions","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equals(200)\r","})"],"type":"text/javascript","id":"7edca1b2-3a2f-4f1a-b73a-0ab803e92300"}}],"id":"1b422c53-91c1-4a0d-a482-685308b2f413","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"}],"url":"https://api.finicity.com/institution/v2/certifiedInstitutions?search=finbank&start=1&limit=25&type=voa","description":"Search for financial institutions by certified product.
\nSupported regions:
Search term (financial institution name field). Leave empty for all FIs.
Index of the page of results to return
\n","type":"text/plain"},"key":"start","value":"1"},{"description":{"content":"Maximum number of results per page
\n","type":"text/plain"},"key":"limit","value":"25"},{"description":{"content":"A product type: \"transAgg\", \"ach\", \"stateAgg\", \"voi\", \"voa\", \"aha\", \"availBalance\", \"accountOwner\"
\n","type":"text/plain"},"key":"type","value":"voa"}],"variable":[]}},"response":[{"id":"c80c3768-5a48-4a88-a943-ee9aa63e1bfb","name":"Institutions were successfully retrieved","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/institution/v2/certifiedInstitutions?search=finbank&start=1&limit=25&type=voa","host":["https://api.finicity.com"],"path":["institution","v2","certifiedInstitutions"],"query":[{"key":"search","value":"finbank"},{"key":"start","value":"1"},{"key":"limit","value":"25"},{"key":"type","value":"voa"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"1002e8b4-6747-4426-8022-c28233410dc3","name":"The request was rejected","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/institution/v2/certifiedInstitutions?search=finbank&start=1&limit=25&type=voa","host":["https://api.finicity.com"],"path":["institution","v2","certifiedInstitutions"],"query":[{"key":"search","value":"finbank"},{"key":"start","value":"1"},{"key":"limit","value":"25"},{"key":"type","value":"voa"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"1d6c655f-9941-4f36-8124-9e74f944fb7e","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/institution/v2/certifiedInstitutions?search=finbank&start=1&limit=25&type=voa","host":["https://api.finicity.com"],"path":["institution","v2","certifiedInstitutions"],"query":[{"key":"search","value":"finbank"},{"key":"start","value":"1"},{"key":"limit","value":"25"},{"key":"type","value":"voa"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"}],"_postman_id":"1b422c53-91c1-4a0d-a482-685308b2f413"},{"name":"Get Institution by ID","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equals(200)\r","})"],"type":"text/javascript","id":"2693b1f1-a15d-4038-bb35-c6db620af262"}}],"id":"f44b52e8-d350-430e-8adf-482cfe2e3b5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"}],"url":"https://api.finicity.com/institution/v2/institutions/{{institutionId}}","description":"Get financial institution details by ID.
\nSupported regions:
Return the branding information for a financial institution.
\nSupported regions:
Search and fetch financial institutions
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["const baseUrl = pm.collectionVariables.get(\"baseUrl\")","const appKey = pm.environment.get(\"appKey\")","const customerId = pm.environment.get(\"customerId\")","const appToken = pm.globals.get(\"appToken\")","pm.variables.set(\"institutionId\", \"4222\") // Principal Financial - Retirement (Personal)"],"id":"8d0a902b-e32b-4231-a990-bc16398fe754"}}],"_postman_id":"741f5993-4e29-4988-94f2-0361e03402a1"},{"name":"Pay Statements","item":[{"name":"Store Customer Pay Statement","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equals(200)\r","})"],"type":"text/javascript","id":"19facf4b-4923-4f71-9922-694f2771e7c1"}}],"id":"0bc0e089-8e33-4923-80bd-061648ab6b94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{\n \"label\": \"lastPayPeriod\",\n \"statement\": \"VGhpcyBtdXN0IGJlIGFuIGltYWdl\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/aggregation/v1/customers/6025984717/payStatements","description":"Use this service to upload pay statements for a customer.
\nSupported regions:
Upload pay statements
\n","_postman_id":"0a73f56a-5835-42ae-ba6e-4a1bd3f3337d"},{"name":"Payments","item":[{"name":"Get Account Owner","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equals(200)\r","})"],"type":"text/javascript","id":"bff6aa18-5eb9-411e-abe0-636bd4763470"}}],"id":"68250a53-8774-4c1c-a856-a278966c6040","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"}],"url":"https://api.finicity.com/aggregation/v1/customers/6025984717/accounts/{{accountId}}/owner","description":"Retrieve the names and addresses of the account owner from a financial institution.
\nNote: this is a premium service, billable per every successful API call.
\nThis service retrieves account data from the institution. This usually returns quickly, but in some scenarios may take a few minutes to complete. In the event of a timeout condition, retry the call.
\nSupported regions:
Return the loan payment details of the customer for a loan-type account.
\nNote: this is a premium service, billable per every successful API call.
\nSupported regions:
Return the real account number and routing number details for an ACH payment.
\nNote: this is a premium service, billable per every successful API call.
\nSupported account types: \"checking\", \"savings\", \"moneyMarket\", \"loan\"
\nSupported regions:
Retrieve the available and cleared account balances for a single account in real-time directly from a financial institution.
\nNote: this is a premium service, billable per every successful API call.
\nSupported account types: \"checking\", \"savings\", \"moneyMarket\", \"cd\"
\nSupported regions:
Retrieve the latest cached available and cleared account balances for a customer. Since we update and store balances throughout the day, this is the most accurate balance information available when a connection to a financial institution is unavailable or when a faster response is needed. Only deposit account types are supported: Checking, Savings, Money Market, and CD.
\nNote: this is a premium service, billable per every successful API call. Enrollment is required.
\nSupported regions:
This service retrieves the account details for an account holder from an institution. The following data objects are available.
\nNote: the data returned varies from institution to institution as not all of them make the same data available. This is a premium service, billable per each successful API call.
\nSupported regions:
Fetch ACH details and account balances
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["const baseUrl = pm.collectionVariables.get(\"baseUrl\")","const appKey = pm.environment.get(\"appKey\")","const customerId = pm.environment.get(\"customerId\")","const appToken = pm.globals.get(\"appToken\")","","const savingAccountId = pm.variables.get(\"savingAccountId\")","const accountId = pm.variables.get(\"accountId\")","if (savingAccountId && accountId) {"," return","}","","console.log(\"Fetching account IDs\")","const options = {"," url: baseUrl + \"/aggregation/v1/customers/\"+ customerId + \"/accounts\","," method: 'GET',"," header: {"," \"Accept\": \"application/json\","," \"Finicity-App-Key\": appKey,"," \"Finicity-App-Token\": appToken"," }","}","pm.sendRequest(options, function (err, response) {"," pm.expect(err).to.be.null"," pm.expect(response.code).to.equals(200)"," const accounts = response.json().accounts;"," const account = accounts.filter(a => a.type === \"savings\")[0]"," pm.variables.set(\"savingAccountId\", account.id)"," pm.variables.set(\"accountId\", accounts[0].id)","})"],"id":"4db91871-cb20-41eb-af80-1633ae631130"}}],"_postman_id":"1f5d9060-3681-4843-bef7-d5f283b75a88"},{"name":"Portfolios","item":[{"name":"Get Portfolio by Customer","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," // HTTP 404: report not yet ready\r"," pm.expect([200, 404]).contain(pm.response.code)\r","})"],"type":"text/javascript","id":"493d88ce-e707-420d-99dc-5bfc308c6268"}}],"id":"3d41bbb9-5175-4afd-85a6-d9ffedefea9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"}],"url":"https://api.finicity.com/decisioning/v1/customers/6025984717/portfolios/{{portfolioId}}","description":"Return a portfolio of most recently generated reports for each report type for the given customer. If there are multiple reports that were generated for a report type (VOA, VOI, etc.), only the most recently generated report for the type will be returned.
\nSupported regions:
Return a portfolio of most recently generated reports for each report type for a given consumer. If there are multiple reports that were generated for a report type (VOA, VOI, etc.), only the most recently generated report for the type will be returned.
\nSupported regions:
Generate portfolios of the most recent reports
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["const baseUrl = pm.collectionVariables.get(\"baseUrl\")","const appKey = pm.environment.get(\"appKey\")","const customerId = pm.environment.get(\"customerId\")","const appToken = pm.globals.get(\"appToken\")","","const portfolioId = pm.variables.get(\"portfolioId\")","const consumerId = pm.variables.get(\"consumerId\")","if (portfolioId && consumerId) {"," return","}","","console.log(\"Fetching portfolio ID and consumer ID ...\")","const options = {"," url: baseUrl + \"/decisioning/v2/customers/\" + customerId + \"/voa\","," method: 'POST',"," header: {"," \"Accept\": \"application/json\","," \"Content-Type\": \"application/json\","," \"Finicity-App-Key\": appKey,"," \"Finicity-App-Token\": appToken"," },"," body: JSON.stringify({})","}","pm.sendRequest(options, function (err, response) {"," pm.expect(err).to.be.null"," pm.expect(response.code).to.equals(202)"," pm.variables.set(\"portfolioId\", response.json().portfolioId)"," pm.variables.set(\"consumerId\", response.json().consumerId)","})"],"id":"45d96c89-625f-4509-b43e-5f9869341ee3"}}],"_postman_id":"74c4e062-a797-4511-b94c-52064d7195a2"},{"name":"Reports","item":[{"name":"Get Report by Customer and ID","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 429])\r","})"],"type":"text/javascript","id":"af8fe0fc-5cca-4e9b-998f-2e7095ceef42"}}],"id":"90636964-c477-4010-a846-fbbc3ad1cd4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"}],"url":"https://api.finicity.com/decisioning/v3/customers/6025984717/reports/{{reportId}}?onBehalfOf=Some entity&purpose=99","description":"Get a report that has been generated by a previous call to one of the Generate Report services.
\nThe report's status field contains \"inProgress\", \"failure\", or \"success\". If the status shows \"inProgress\", the client app should wait 20 seconds and then call this API again.
Supported regions:
(Required) The name of the entity you are retrieving the report on behalf of
\n","type":"text/plain"},"key":"onBehalfOf","value":"Some entity"},{"description":{"content":"2-digit code from Permissible Purpose Codes, specifying the reason for retrieving this report. Required for retrieving some reports.
\n","type":"text/plain"},"key":"purpose","value":"99"}],"variable":[]}},"response":[{"id":"9ee54ddd-35da-4834-b567-c67769f6ee5d","name":"The report was successfully retrieved","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v3/customers/:customerId/reports/:reportId?onBehalfOf=Some entity&purpose=99","host":["https://api.finicity.com"],"path":["decisioning","v3","customers",":customerId","reports",":reportId"],"query":[{"key":"onBehalfOf","value":"Some entity"},{"key":"purpose","value":"99"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"},{"key":"reportId","value":"u4hstnnak45g","description":"(Required) ID of the report"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"57ad964b-44f3-4fde-bd40-560c05cfe5db","name":"The request was rejected","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v3/customers/:customerId/reports/:reportId?onBehalfOf=Some entity&purpose=99","host":["https://api.finicity.com"],"path":["decisioning","v3","customers",":customerId","reports",":reportId"],"query":[{"key":"onBehalfOf","value":"Some entity"},{"key":"purpose","value":"99"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"},{"key":"reportId","value":"u4hstnnak45g","description":"(Required) ID of the report"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"8c389346-9691-48cc-a748-20026e66747c","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v3/customers/:customerId/reports/:reportId?onBehalfOf=Some entity&purpose=99","host":["https://api.finicity.com"],"path":["decisioning","v3","customers",":customerId","reports",":reportId"],"query":[{"key":"onBehalfOf","value":"Some entity"},{"key":"purpose","value":"99"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"},{"key":"reportId","value":"u4hstnnak45g","description":"(Required) ID of the report"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"826da6de-cb30-4f63-8894-aa8afe360a4a","name":"The resource doesn't exist","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v3/customers/:customerId/reports/:reportId?onBehalfOf=Some entity&purpose=99","host":["https://api.finicity.com"],"path":["decisioning","v3","customers",":customerId","reports",":reportId"],"query":[{"key":"onBehalfOf","value":"Some entity"},{"key":"purpose","value":"99"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"},{"key":"reportId","value":"u4hstnnak45g","description":"(Required) ID of the report"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"}],"_postman_id":"90636964-c477-4010-a846-fbbc3ad1cd4e"},{"name":"Get Report by Consumer and ID","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 429])\r","})"],"type":"text/javascript","id":"3f238b01-2888-49f9-ab37-a11fdd1ad45a"}}],"id":"60f25425-d356-478f-9eb9-2e1504cd9400","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"}],"url":"https://api.finicity.com/decisioning/v3/consumers/{{consumerId}}/reports/{{reportId}}?purpose=99&onBehalfOf=Some entity","description":"Get a report that has been generated by a previous call to one of the Generate Report services.
\nThe report's status field contains \"inProgress\", \"failure\", or \"success\". If the status shows \"inProgress\", the client app should wait 20 seconds and then call this API again.
Supported regions:
2-digit code from Permissible Purpose Codes, specifying the reason for retrieving this report. Required for retrieving some reports.
\n","type":"text/plain"},"key":"purpose","value":"99"},{"description":{"content":"(Required) The name of the entity you are retrieving the report on behalf of
\n","type":"text/plain"},"key":"onBehalfOf","value":"Some entity"}],"variable":[]}},"response":[{"id":"ffcaa721-272f-41d4-8c09-74533849138d","name":"The report was successfully retrieved","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v3/consumers/:consumerId/reports/:reportId?purpose=99&onBehalfOf=Some entity","host":["https://api.finicity.com"],"path":["decisioning","v3","consumers",":consumerId","reports",":reportId"],"query":[{"key":"purpose","value":"99"},{"key":"onBehalfOf","value":"Some entity"}],"variable":[{"key":"consumerId","value":"0bf46322c167b562e6cbed9d40e19a4c","description":"(Required) The consumer ID"},{"key":"reportId","value":"u4hstnnak45g","description":"(Required) ID of the report"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"df694856-d00c-47b0-b5da-9abe3f952c4f","name":"The request was rejected","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v3/consumers/:consumerId/reports/:reportId?purpose=99&onBehalfOf=Some entity","host":["https://api.finicity.com"],"path":["decisioning","v3","consumers",":consumerId","reports",":reportId"],"query":[{"key":"purpose","value":"99"},{"key":"onBehalfOf","value":"Some entity"}],"variable":[{"key":"consumerId","value":"0bf46322c167b562e6cbed9d40e19a4c","description":"(Required) The consumer ID"},{"key":"reportId","value":"u4hstnnak45g","description":"(Required) ID of the report"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"3fe8c9a2-1dd0-475d-b99d-683cd72bfb56","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v3/consumers/:consumerId/reports/:reportId?purpose=99&onBehalfOf=Some entity","host":["https://api.finicity.com"],"path":["decisioning","v3","consumers",":consumerId","reports",":reportId"],"query":[{"key":"purpose","value":"99"},{"key":"onBehalfOf","value":"Some entity"}],"variable":[{"key":"consumerId","value":"0bf46322c167b562e6cbed9d40e19a4c","description":"(Required) The consumer ID"},{"key":"reportId","value":"u4hstnnak45g","description":"(Required) ID of the report"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"8745412e-aa72-4ebe-8dcc-9f27839328cd","name":"The resource doesn't exist","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v3/consumers/:consumerId/reports/:reportId?purpose=99&onBehalfOf=Some entity","host":["https://api.finicity.com"],"path":["decisioning","v3","consumers",":consumerId","reports",":reportId"],"query":[{"key":"purpose","value":"99"},{"key":"onBehalfOf","value":"Some entity"}],"variable":[{"key":"consumerId","value":"0bf46322c167b562e6cbed9d40e19a4c","description":"(Required) The consumer ID"},{"key":"reportId","value":"u4hstnnak45g","description":"(Required) ID of the report"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"}],"_postman_id":"60f25425-d356-478f-9eb9-2e1504cd9400"},{"name":"Get Reports by Customer ID","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 429])\r","})"],"type":"text/javascript","id":"27d5271a-2732-4b85-a680-df8c0bdc17a1"}}],"id":"da2ba4ac-c1e4-4358-a4cb-ec8feb889322","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"}],"url":"https://api.finicity.com/decisioning/v1/customers/6025984717/reports","description":"Get all reports that have been generated by previous calls to Generate Report services for the given customer.
\nThe status fields in the returned contain \"inProgress\", \"failure\", or \"success\". If the status shows \"inProgress\", the client app should wait 20 seconds and then call this API again.
Supported regions:
2-digit code from Permissible Purpose Codes, specifying the reason for retrieving this report. Required for retrieving some reports.
\n","type":"text/plain"},"key":"purpose","value":"99"}],"variable":[]}},"response":[{"id":"a0c398e5-581c-414d-ac20-8357fce9a9c0","name":"The reports summaries were successfully retrieved","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v1/customers/:customerId/reports?purpose=99","host":["https://api.finicity.com"],"path":["decisioning","v1","customers",":customerId","reports"],"query":[{"key":"purpose","value":"99"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"a41ae7a3-f589-4c7e-989f-7fe01b74ee16","name":"The request was rejected","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v1/customers/:customerId/reports?purpose=99","host":["https://api.finicity.com"],"path":["decisioning","v1","customers",":customerId","reports"],"query":[{"key":"purpose","value":"99"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"c7422e22-1d85-45c1-b22e-99b5741773d7","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v1/customers/:customerId/reports?purpose=99","host":["https://api.finicity.com"],"path":["decisioning","v1","customers",":customerId","reports"],"query":[{"key":"purpose","value":"99"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"413d9a0a-0b2c-447f-920b-80777d84e251","name":"The resource doesn't exist","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v1/customers/:customerId/reports?purpose=99","host":["https://api.finicity.com"],"path":["decisioning","v1","customers",":customerId","reports"],"query":[{"key":"purpose","value":"99"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"},{"id":"082b2c9e-24f3-4030-a209-4d92bcb22112","name":"The service can't accept more requests or is not available from the [Test Drive](https://signup.finicity.com/).","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v1/customers/:customerId/reports?purpose=99","host":["https://api.finicity.com"],"path":["decisioning","v1","customers",":customerId","reports"],"query":[{"key":"purpose","value":"99"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"da2ba4ac-c1e4-4358-a4cb-ec8feb889322"},{"name":"Get Reports by Consumer ID","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 429])\r","})"],"type":"text/javascript","id":"d057e36c-f6ac-4223-a07a-12d6d98f0e91"}}],"id":"11ee993a-fa0c-4009-a1e5-efd090fd21b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"}],"url":"https://api.finicity.com/decisioning/v1/consumers/{{consumerId}}/reports","description":"Get all reports that have been generated by previous calls to Generate Report services for the given consumer.
\nThe status fields in the returned contain \"inProgress\", \"failure\", or \"success\". If the status shows \"inProgress\", the client app should wait 20 seconds and then call this API again.
Supported regions:
2-digit code from Permissible Purpose Codes, specifying the reason for retrieving this report. Required for retrieving some reports.
\n","type":"text/plain"},"key":"purpose","value":"99"}],"variable":[]}},"response":[{"id":"a45f510d-85f8-4110-9e02-a49a9a0867e9","name":"The reports summaries were successfully retrieved","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v1/consumers/:consumerId/reports?purpose=99","host":["https://api.finicity.com"],"path":["decisioning","v1","consumers",":consumerId","reports"],"query":[{"key":"purpose","value":"99"}],"variable":[{"key":"consumerId","value":"0bf46322c167b562e6cbed9d40e19a4c","description":"(Required) The consumer ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"a5a2dd9d-2d16-4733-b17b-13a3c03547d2","name":"The request was rejected","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v1/consumers/:consumerId/reports?purpose=99","host":["https://api.finicity.com"],"path":["decisioning","v1","consumers",":consumerId","reports"],"query":[{"key":"purpose","value":"99"}],"variable":[{"key":"consumerId","value":"0bf46322c167b562e6cbed9d40e19a4c","description":"(Required) The consumer ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"f1f79e0a-1cd4-4bdf-8f7e-e6a7afd748fe","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v1/consumers/:consumerId/reports?purpose=99","host":["https://api.finicity.com"],"path":["decisioning","v1","consumers",":consumerId","reports"],"query":[{"key":"purpose","value":"99"}],"variable":[{"key":"consumerId","value":"0bf46322c167b562e6cbed9d40e19a4c","description":"(Required) The consumer ID"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"b66b6655-faa3-4db7-9369-a221d7850524","name":"The resource doesn't exist","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v1/consumers/:consumerId/reports?purpose=99","host":["https://api.finicity.com"],"path":["decisioning","v1","consumers",":consumerId","reports"],"query":[{"key":"purpose","value":"99"}],"variable":[{"key":"consumerId","value":"0bf46322c167b562e6cbed9d40e19a4c","description":"(Required) The consumer ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"},{"id":"54c81803-b765-4817-834c-c68064a09e81","name":"The service can't accept more requests or is not available from the [Test Drive](https://signup.finicity.com/).","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v1/consumers/:consumerId/reports?purpose=99","host":["https://api.finicity.com"],"path":["decisioning","v1","consumers",":consumerId","reports"],"query":[{"key":"purpose","value":"99"}],"variable":[{"key":"consumerId","value":"0bf46322c167b562e6cbed9d40e19a4c","description":"(Required) The consumer ID"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"11ee993a-fa0c-4009-a1e5-efd090fd21b1"}],"id":"384d5124-2614-4797-9d34-ea4eda5b9c18","description":"Fetch generated reports when ready
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["const baseUrl = pm.collectionVariables.get(\"baseUrl\")","const appKey = pm.environment.get(\"appKey\")","const customerId = pm.environment.get(\"customerId\")","const appToken = pm.globals.get(\"appToken\")","const accountId = pm.variables.get(\"accountId\")","const reportId = pm.variables.get(\"reportId\")","const consumerId = pm.variables.get(\"consumerId\")","","createConsumer()","fetchReportIdAndConsumerId()","","function createConsumer() {"," const consumerExists = pm.globals.get(\"consumerExists\")"," if (consumerExists) {"," // A consumer was already created"," return"," }",""," console.log(\"Creating consumer ... \")"," const options = {"," url: baseUrl + \"/decisioning/v1/customers/\" + customerId + \"/consumer\", "," method: 'POST',"," header: {"," \"Accept\": \"application/json\","," \"Content-type\": \"application/json\","," \"Finicity-App-Key\": appKey,"," \"Finicity-App-Token\": appToken"," },"," body: JSON.stringify({"," \"firstName\": \"Homer\","," \"lastName\": \"Loanseeke\","," \"address\": \"434 W Ascension Way\","," \"city\": \"Murray\","," \"state\": \"UT\","," \"zip\": \"84123\","," \"phone\": \"1-800-986-3343\","," \"ssn\": \"999601111\","," \"birthday\": {"," \"year\": 1970,"," \"month\": 7,"," \"dayOfMonth\": 4"," },"," \"email\": \"finicity@test.com\","," \"suffix\": \"Mr\""," })"," }"," pm.sendRequest(options, function (err, response) {"," pm.expect(err).to.be.null"," pm.expect(response.code).to.be.oneOf([200, 201, 409])"," pm.globals.set(\"consumerExists\", true)"," })","}","","function fetchReportIdAndConsumerId() {"," if (reportId && consumerId) {"," return"," }"," "," console.log(\"Fetching report ID and consumer ID ...\")"," const options = {"," url: baseUrl + \"/decisioning/v2/customers/\" + customerId + \"/voa\","," method: 'POST',"," header: {"," \"Accept\": \"application/json\","," \"Content-Type\": \"application/json\","," \"Finicity-App-Key\": appKey,"," \"Finicity-App-Token\": appToken"," },"," body: JSON.stringify({})"," }"," pm.sendRequest(options, function (err, response) {"," pm.expect(err).to.be.null"," pm.expect(response.code).to.equals(202)"," pm.variables.set(\"reportId\", response.json().id)"," pm.variables.set(\"consumerId\", response.json().consumerId)"," })","}",""],"id":"68eeb050-86ce-4397-aaa0-9b0f717fffb1"}}],"_postman_id":"384d5124-2614-4797-9d34-ea4eda5b9c18"},{"name":"Third Party Access","item":[{"name":"Generate Third Party Access Key","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equals(200)\r","\r"," /* Store the receipt ID */\r"," const receiptId = pm.response.json().data[0].receipt.receiptId\r"," pm.globals.set(\"receiptId\", receiptId)\r","})"],"type":"text/javascript","id":"e1cfed05-ea4f-44b3-a155-c83dae146ae6"}}],"id":"fbf0db45-2a68-403a-838b-89565a738a38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"6025984717\",\r\n \"partnerId\": \"2445584195057\",\r\n \"thirdPartyPartnerId\": \"1234583871234\",\r\n \"provenance\": {\r\n \"clientFingerprint\": \"LU9ZYxcDNQCwEmAxH52XFzaRiGMAAAAABclSKxW5S9P8pUMDV4fbpg\",\r\n \"ipAddress\": \"8.8.8.8\",\r\n \"token\": \"P9YbR+srNVyQI35893d+BzPrhGMAAAAAuacVUt+3m4svbaFjVSbHEA==\"\r\n },\r\n \"products\": [\r\n {\r\n \"product\": \"moneyTransferDetails\",\r\n \"payorId\": \"2445581559892\",\r\n \"maxCalls\": 200,\r\n \"accountId\": \"{{accountId}}\",\r\n \"accessPeriod\": {\r\n \"type\": \"timeframe\",\r\n \"startTime\": \"{{nowIso8601}}\",\r\n \"endTime\": \"{{tomorrowIso8601}}\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/aggregation/v1/partners/accessKey","description":"Generate access key for third party partners.
\nA partner can provide access to third party partners with this access key.
\n","urlObject":{"path":["aggregation","v1","partners","accessKey"],"host":["https://api.finicity.com"],"query":[],"variable":[]}},"response":[{"id":"686a34f6-8628-420b-9a6e-2132ddae8071","name":"The third party access key was successfully generated","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"Update access for third party partners
\n","urlObject":{"path":["aggregation","v1","partners","accessKey","{{receiptId}}"],"host":["https://api.finicity.com"],"query":[],"variable":[]}},"response":[{"id":"e348d8c1-8441-46af-b920-abcb4b70f77f","name":"The third party access key was successfully updated","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"Revoke access of third party partners
\n","urlObject":{"path":["aggregation","v1","partners","accessKey","{{receiptId}}"],"host":["https://api.finicity.com"],"query":[],"variable":[]}},"response":[{"id":"6299febd-fe41-40d0-ac74-fe2b5ca80fa9","name":"The third party access key was successfully revoked","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"Generate and manage access keys for other partners
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["const baseUrl = pm.collectionVariables.get(\"baseUrl\")","const appKey = pm.environment.get(\"appKey\")","const customerId = pm.environment.get(\"customerId\")","const appToken = pm.globals.get(\"appToken\")","","const accountId = pm.variables.get(\"accountId\")","if (accountId) {"," return","}","","console.log(\"Fetching account ID ...\")","const options = {"," url: baseUrl + \"/aggregation/v1/customers/\"+ customerId + \"/accounts\","," method: 'GET',"," header: {"," \"Accept\": \"application/json\","," \"Finicity-App-Key\": appKey,"," \"Finicity-App-Token\": appToken"," }","}","pm.sendRequest(options, function (err, response) {"," pm.expect(err).to.be.null"," pm.expect(response.code).to.equals(200)"," const account = response.json().accounts[0]"," pm.variables.set(\"accountId\", account.id)","})"],"id":"58e66be6-3208-4a35-9e6f-1916e5dc210f"}}],"_postman_id":"e25bf14e-043a-4fae-a061-fff83b8d41f9"},{"name":"Transactions","item":[{"name":"Load Historic Transactions for Customer Account","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equals(204)\r","})"],"type":"text/javascript","id":"ce25fcfd-2fbb-4208-9c2c-5f26e96ea520"}}],"id":"f4b8dee9-4183-4e8d-83a7-3ac1c7489e6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/aggregation/v1/customers/6025984717/accounts/{{accountId}}/transactions/historic","description":"Connect to the account's financial institution and load up to 24 months of historic transactions for the account. Length of history varies by institution.
\nThis is a premium service. The billable event is a call to this service specifying a customer ID that has not been seen before by this service. (If this service is called multiple times with the same customer ID, to load transactions from multiple accounts, only one billable event has occurred.)
\nThe recommended timeout setting for this request is 180 seconds in order to receive a response. However, you can terminate the connection after making the call the operation will still complete. You will have to pull the account records to check for an updated aggregation attempt date to know when the refresh is complete.
\nThe date range sent to the institution is calculated from the account's createdDate. This means that calling this service a second time for the same account normally will not add any new transactions for the account. For this reason, a second call to this service for a known account ID will usually return immediately.
In a few specific scenarios, it may be desirable to force a second connection to the institution for a known account ID. Some examples are:
\nIn these cases, the POST request can contain the parameter force=true in the request body to force the second connection.
Supported regions:
Get all transactions available for this customer within the given date range, across all accounts. This service supports paging and sorting by transactionDate (or postedDate if no transaction date is provided), with a maximum of 1000 transactions per request.
Standard consumer aggregation provides up to 180 days of transactions prior to the date each account was added to the Finicity system. To access older transactions, you must first call the service Load Historic Transactions for Account.
\nThere is no limit for the size of the window between fromDate and toDate, however, the maximum number of transactions returned on one page is 1000.
Supported regions:
(Required) A start date
\n","type":"text/plain"},"key":"fromDate","value":"1000000000"},{"disabled":true,"description":{"content":"Index of the page of results to return
\n","type":"text/plain"},"key":"start","value":"1"},{"disabled":true,"description":{"content":"Maximum number of results per page
\n","type":"text/plain"},"key":"limit","value":"25"},{"disabled":true,"description":{"content":"Date sort order: \"asc\" for ascending, \"desc\" for descending
\n","type":"text/plain"},"key":"sort","value":"desc"},{"description":{"content":"If pending transactions must be included
\n","type":"text/plain"},"key":"includePending","value":"true"},{"description":{"content":"(Required) A end date
\n","type":"text/plain"},"key":"toDate","value":"1665309262"}],"variable":[]}},"response":[{"id":"8486a06a-29f5-47ff-8aef-a323be42a71f","name":"The transactions were successfully retrieved","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v3/customers/:customerId/transactions?fromDate=1607450357&toDate=1607450357&start=1&limit=25&sort=desc&includePending=true","host":["https://api.finicity.com"],"path":["aggregation","v3","customers",":customerId","transactions"],"query":[{"key":"fromDate","value":"1607450357"},{"key":"toDate","value":"1607450357"},{"key":"start","value":"1"},{"key":"limit","value":"25"},{"key":"sort","value":"desc"},{"key":"includePending","value":"true"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"5fa70385-7db4-431e-ad65-b9a48b12353a","name":"The request was rejected","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v3/customers/:customerId/transactions?fromDate=1607450357&toDate=1607450357&start=1&limit=25&sort=desc&includePending=true","host":["https://api.finicity.com"],"path":["aggregation","v3","customers",":customerId","transactions"],"query":[{"key":"fromDate","value":"1607450357"},{"key":"toDate","value":"1607450357"},{"key":"start","value":"1"},{"key":"limit","value":"25"},{"key":"sort","value":"desc"},{"key":"includePending","value":"true"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"5cb6b4b5-bffb-448f-9186-2f976fe7e2eb","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v3/customers/:customerId/transactions?fromDate=1607450357&toDate=1607450357&start=1&limit=25&sort=desc&includePending=true","host":["https://api.finicity.com"],"path":["aggregation","v3","customers",":customerId","transactions"],"query":[{"key":"fromDate","value":"1607450357"},{"key":"toDate","value":"1607450357"},{"key":"start","value":"1"},{"key":"limit","value":"25"},{"key":"sort","value":"desc"},{"key":"includePending","value":"true"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"901b91a2-ed1b-40e0-b559-ebb13544ee58","name":"The resource doesn't exist","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v3/customers/:customerId/transactions?fromDate=1607450357&toDate=1607450357&start=1&limit=25&sort=desc&includePending=true","host":["https://api.finicity.com"],"path":["aggregation","v3","customers",":customerId","transactions"],"query":[{"key":"fromDate","value":"1607450357"},{"key":"toDate","value":"1607450357"},{"key":"start","value":"1"},{"key":"limit","value":"25"},{"key":"sort","value":"desc"},{"key":"includePending","value":"true"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"}],"_postman_id":"ce679ddd-37be-4509-beb9-f80d46eb4bc3"},{"name":"Get Customer Transaction by ID","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equal(404)\r","})"],"type":"text/javascript","id":"379affb8-d498-4e20-bec1-1cf096071360"}}],"id":"32b17596-3cd3-42b3-8734-9a1371034cf9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"}],"url":"https://api.finicity.com/aggregation/v2/customers/6025984717/transactions/1234","description":"Get details for the given transaction.
\nSupported regions:
Get all transactions available for this customer account within the given date range. This service supports paging and sorting by transactionDate (or postedDate if no transaction date is provided), with a maximum of 1000 transactions per request.
Standard consumer aggregation provides up to 180 days of transactions prior to the date each account was added to the Finicity system. To access older transactions, you must first call the Cash Flow Verification service Load Historic Transactions for Account.
\nThere is no limit for the size of the window between fromDate and toDate, however, the maximum number of transactions returned on one page is 1000.
Supported regions:
(Required) A start date
\n","type":"text/plain"},"key":"fromDate","value":"1000000000"},{"disabled":true,"description":{"content":"Index of the page of results to return
\n","type":"text/plain"},"key":"start","value":"1"},{"disabled":true,"description":{"content":"Maximum number of results per page
\n","type":"text/plain"},"key":"limit","value":"25"},{"disabled":true,"description":{"content":"Date sort order: \"asc\" for ascending, \"desc\" for descending
\n","type":"text/plain"},"key":"sort","value":"desc"},{"description":{"content":"If pending transactions must be included
\n","type":"text/plain"},"key":"includePending","value":"true"},{"description":{"content":"(Required) A end date
\n","type":"text/plain"},"key":"toDate","value":"1665309262"}],"variable":[]}},"response":[{"id":"23132d3f-64f9-458a-a0e3-3efd730ecf34","name":"The transactions were successfully retrieved","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v3/customers/:customerId/accounts/:accountId/transactions?fromDate=1607450357&toDate=1607450357&start=1&limit=25&sort=desc&includePending=true","host":["https://api.finicity.com"],"path":["aggregation","v3","customers",":customerId","accounts",":accountId","transactions"],"query":[{"key":"fromDate","value":"1607450357"},{"key":"toDate","value":"1607450357"},{"key":"start","value":"1"},{"key":"limit","value":"25"},{"key":"sort","value":"desc"},{"key":"includePending","value":"true"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"},{"key":"accountId","value":"5011648377","description":"(Required) The account ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"c04ab3f2-1278-4486-b1da-2d5a69ac1da3","name":"The request was rejected","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v3/customers/:customerId/accounts/:accountId/transactions?fromDate=1607450357&toDate=1607450357&start=1&limit=25&sort=desc&includePending=true","host":["https://api.finicity.com"],"path":["aggregation","v3","customers",":customerId","accounts",":accountId","transactions"],"query":[{"key":"fromDate","value":"1607450357"},{"key":"toDate","value":"1607450357"},{"key":"start","value":"1"},{"key":"limit","value":"25"},{"key":"sort","value":"desc"},{"key":"includePending","value":"true"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"},{"key":"accountId","value":"5011648377","description":"(Required) The account ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"b46d7215-53b1-4070-8d68-3ed5ce2a2e90","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v3/customers/:customerId/accounts/:accountId/transactions?fromDate=1607450357&toDate=1607450357&start=1&limit=25&sort=desc&includePending=true","host":["https://api.finicity.com"],"path":["aggregation","v3","customers",":customerId","accounts",":accountId","transactions"],"query":[{"key":"fromDate","value":"1607450357"},{"key":"toDate","value":"1607450357"},{"key":"start","value":"1"},{"key":"limit","value":"25"},{"key":"sort","value":"desc"},{"key":"includePending","value":"true"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"},{"key":"accountId","value":"5011648377","description":"(Required) The account ID"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"f2f5eddb-b7fd-4ba3-b502-c0ea4ecb5150","name":"The resource doesn't exist","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/aggregation/v3/customers/:customerId/accounts/:accountId/transactions?fromDate=1607450357&toDate=1607450357&start=1&limit=25&sort=desc&includePending=true","host":["https://api.finicity.com"],"path":["aggregation","v3","customers",":customerId","accounts",":accountId","transactions"],"query":[{"key":"fromDate","value":"1607450357"},{"key":"toDate","value":"1607450357"},{"key":"start","value":"1"},{"key":"limit","value":"25"},{"key":"sort","value":"desc"},{"key":"includePending","value":"true"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"},{"key":"accountId","value":"5011648377","description":"(Required) The account ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"}],"_postman_id":"43db98ef-9b60-44ba-81d1-0af5a7c1bf2e"},{"name":"Generate Transactions Report","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([202, 429, 401])\r","})"],"type":"text/javascript","id":"0756f7ad-2b6f-451a-8df3-3ac21906e533"}},{"listen":"prerequest","script":{"exec":["// A consumer is needed for this API\r","createConsumer()\r","\t\r","function createConsumer() {\r"," const baseUrl = pm.collectionVariables.get(\"baseUrl\")\r"," const customerId = pm.environment.get(\"customerId\")\r"," const appKey = pm.environment.get(\"appKey\")\r"," const appToken = pm.globals.get(\"appToken\")\r","\r"," const consumerExists = pm.globals.get(\"consumerExists\")\r"," if (consumerExists) {\r"," // A consumer was already created\r"," return\r"," }\r","\r"," console.log(\"Creating consumer ... \")\r"," const options = {\r"," url: baseUrl + \"/decisioning/v1/customers/\" + customerId + \"/consumer\", \r"," method: 'POST',\r"," header: {\r"," \"Accept\": \"application/json\",\r"," \"Content-type\": \"application/json\",\r"," \"Finicity-App-Key\": appKey,\r"," \"Finicity-App-Token\": appToken\r"," },\r"," body: JSON.stringify({\r"," \"firstName\": \"Homer\",\r"," \"lastName\": \"Loanseeke\",\r"," \"address\": \"434 W Ascension Way\",\r"," \"city\": \"Murray\",\r"," \"state\": \"UT\",\r"," \"zip\": \"84123\",\r"," \"phone\": \"1-800-986-3343\",\r"," \"ssn\": \"999601111\",\r"," \"birthday\": {\r"," \"year\": 1970,\r"," \"month\": 7,\r"," \"dayOfMonth\": 4\r"," },\r"," \"email\": \"finicity@test.com\",\r"," \"suffix\": \"Mr\"\r"," })\r"," }\r"," pm.sendRequest(options, function (err, response) {\r"," pm.expect(err).to.be.null\r"," pm.expect(response.code).to.be.oneOf([200, 201, 409])\r"," pm.globals.set(\"consumerExists\", true)\r"," })\r","}"],"type":"text/javascript","id":"a8ae400b-9882-435d-aa20-1b7fa74bf594"}}],"id":"9163443f-228b-480e-a9a7-291d69ac9c52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportCustomFields\": [\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n },\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n }\n ],\n \"showNsf\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/decisioning/v2/customers/6025984717/transactions","description":"Generate a Transaction Report for the given accounts under the given customer. This service retrieves up to 24 months of transaction history for the given customer. It then uses this information to generate the Transaction Report.
\nThis is a premium service. A billable event will be created upon the successful generation of the Transactions Report.
\nBefore calling this API, a consumer must be created for the given customer ID (see Consumers APIs).
\nThere cannot be more than 24 months between fromDate and toDate.
Supported regions:
A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code.
\n","type":"text/plain"},"key":"callbackUrl","value":"https://finicity-test/webhook"},{"disabled":true,"description":{"content":"(Required) A end date
\n","type":"text/plain"},"key":"toDate","value":"1607450357"},{"disabled":true,"description":{"content":"If pending transactions must be included
\n","type":"text/plain"},"key":"includePending","value":"true"}],"variable":[]}},"response":[{"id":"0966d4ff-4318-404a-abd4-c7dd01e8d1b8","name":"The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/transactions?callbackUrl=https://finicity-test/webhook&toDate=1607450357&includePending=true","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","transactions"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"},{"key":"toDate","value":"1607450357"},{"key":"includePending","value":"true"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"e88ad58f-2882-43c1-a4e0-62309db886fa","name":"The request was rejected","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/transactions?callbackUrl=https://finicity-test/webhook&toDate=1607450357&includePending=true","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","transactions"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"},{"key":"toDate","value":"1607450357"},{"key":"includePending","value":"true"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"f1e512a9-c008-4298-a843-b8fe3515536f","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/transactions?callbackUrl=https://finicity-test/webhook&toDate=1607450357&includePending=true","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","transactions"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"},{"key":"toDate","value":"1607450357"},{"key":"includePending","value":"true"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"c876c160-7cc9-48b9-908f-1295e05bd348","name":"The resource doesn't exist","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/transactions?callbackUrl=https://finicity-test/webhook&toDate=1607450357&includePending=true","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","transactions"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"},{"key":"toDate","value":"1607450357"},{"key":"includePending","value":"true"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"}],"_postman_id":"9163443f-228b-480e-a9a7-291d69ac9c52"}],"id":"88b21616-a357-47a6-89a4-2af5878f4ed2","description":"Fetch customer and account transactions and generate reports asynchronously
\n","_postman_id":"88b21616-a357-47a6-89a4-2af5878f4ed2"},{"name":"TxPush","item":[{"name":"Subscribe to TxPush Notifications","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.equals(201)\r","})"],"type":"text/javascript","id":"d7a6ddf4-d730-44cc-b329-0b9498069168"}}],"id":"692e7216-c3d5-43f0-a986-dc2749e4cc99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{\n \"callbackUrl\": \"https://eo309tmtekubcq.m.pipedream.net/\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/aggregation/v1/customers/6025984717/accounts/{{accountId}}/txpush","description":"Register a client app's TxPush Listener to receive TxPush notifications related to the given account.
\nEach call to this service will return two records, one with class account and one with class transaction. Account events are sent when values change in the account's fields (such as balance or interestRate). Transaction events are sent whenever a new transaction is posted for the account. For institutions that do not provide TxPush services, notifications are sent as soon as Finicity finds a new transaction or new account data through regular aggregation processes.
The listener's URL must be secure (HTTPS) for any real-world account. In addition, the client's TxPush Listener will need to be verified. HTTP and HTTPS connections are only allowed on the standard ports 80 (HTTP) and 443 (HTTPS). The use of other ports will result with the call failing.
\nFor additional details on this process, see TxPush Listener Service.
\nSupported regions:
Delete all TxPush subscriptions with their notifications for the given account. No more notifications will be sent for account or transaction events.
\nFor additional details on this process, see TxPush Listener Service.
\nSupported regions:
Inject a transaction into the transaction list for a testing account. This allows an app to trigger TxPush notifications for the account in order to test the app's TxPush Listener service. This causes the platform to send one transaction event and one account event (showing that the account balance has changed). This service is only supported for testing accounts.
\nFor additional details on this process, see TxPush Listener Service.
\nSupported regions:
Delete a specific subscription to TxPush notifications for the given account. This could be individual deleting the account or transactions events. No more events will be sent for that specific subscription.
\nFor additional details on this process, see TxPush Listener Service.
\nSupported regions:
Manage TxPush subscriptions
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["const baseUrl = pm.collectionVariables.get(\"baseUrl\")","const appKey = pm.environment.get(\"appKey\")","const customerId = pm.environment.get(\"customerId\")","const appToken = pm.globals.get(\"appToken\")","","const accountId = pm.variables.get(\"accountId\")","if (accountId) {"," return","}","","console.log(\"Fetching account ID ...\")","const options = {"," url: baseUrl + \"/aggregation/v1/customers/\"+ customerId + \"/accounts\","," method: 'GET',"," header: {"," \"Accept\": \"application/json\","," \"Finicity-App-Key\": appKey,"," \"Finicity-App-Token\": appToken"," }","}","pm.sendRequest(options, function (err, response) {"," pm.expect(err).to.be.null"," pm.expect(response.code).to.equals(200)"," pm.variables.set(\"accountId\", response.json().accounts[0].id)","})"],"id":"cd977e64-2f0b-4451-890e-7a2cd8804935"}}],"_postman_id":"cf6e3da2-b83d-4304-a0df-23e657adfede"},{"name":"Verify Assets","item":[{"name":"Generate VOA Report","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([202, 429, 401])\r","})"],"type":"text/javascript","id":"a54d1f3e-9c23-4280-b4b1-8b1964bd5278"}}],"id":"e4134603-250c-47ab-8dec-298fbfcfb692","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportCustomFields\": [\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n },\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n }\n ],\n \"showNsf\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/decisioning/v2/customers/6025984717/voa","description":"Generate a Verification of Assets (VOA) report for all checking, savings, money market, and investment accounts for the given customer. This service retrieves up to twelve months of transaction history for each account and uses this information to generate the VOA report.
\nThis is a premium service. The billing rate is the variable rate for Verification of Assets under the current subscription plan. The billable event is the successful generation of a VOA report.
\nBefore calling this API, a consumer must be created for the given customer ID (see Consumers APIs).
\nIf no account of type checking, savings, money market, or investment is found, the service will return HTTP 400 Bad Request.
\nSupported regions:
A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code.
\n","type":"text/plain"},"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[]}},"response":[{"id":"77afb638-4fd8-489c-adc6-d2d681e892c5","name":"The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voa?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voa"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"50ab9f7e-ad43-491b-a8b6-b886ccbba10c","name":"The request was rejected","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voa?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voa"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"c2a5dcd6-4804-4901-9e63-99b975f83b6e","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voa?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voa"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"7196b889-70ab-4f01-b0ab-93506a337cbd","name":"The resource doesn't exist","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voa?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voa"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"}],"_postman_id":"e4134603-250c-47ab-8dec-298fbfcfb692"},{"name":"Generate VOA With Income Report","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([202, 429, 401])\r","})"],"type":"text/javascript","id":"769efeb6-2f60-4736-ab33-62a44dc8d1aa"}}],"id":"5cd5fb36-0693-4fc7-b540-9e4efd7d7ca0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportCustomFields\": [\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n },\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n }\n ],\n \"showNsf\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/decisioning/v2/customers/6025984717/voaHistory","description":"Generate a Verification of Assets with Income (VOAI) report for all checking, savings, money market, and investment accounts for the given customer. This service retrieves up to 24 months of transaction history for each account and uses this information to generate the VOAI report. The report includes 1 - 6 months of all debit and credit transactions for asset verification. By default, the history is set to 61 days, however, you can change the transaction history in this section by setting the fromDate parameter. The report also includes up to 24 months of income credit transactions (ordered by account and confidence level) regardless of fromDate for income verification.
This is a premium service. The billable event is the successful generation of a VOAI report.
\nBefore calling this API, a consumer must be created for the given customer ID (see Consumers APIs).
\nIf no account of type checking, savings, money market, or investment is found, the service will return HTTP 400 Bad Request.
\nSupported regions:
A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code.
\n","type":"text/plain"},"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[]}},"response":[{"id":"a5f48dd1-3531-40e3-b979-4f09c1db67bc","name":"The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voaHistory?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voaHistory"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"94f59b56-b840-47d7-ba18-7ca6e9f25292","name":"The request was rejected","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voaHistory?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voaHistory"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"244ba53b-112e-40aa-98ec-1207df990edb","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voaHistory?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voaHistory"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"5904d0e0-dcef-4771-88d9-fe1ae0c6b8c5","name":"The resource doesn't exist","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voaHistory?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voaHistory"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"}],"_postman_id":"5cd5fb36-0693-4fc7-b540-9e4efd7d7ca0"},{"name":"Generate Prequalification Report","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([202, 429, 401])\r","})"],"type":"text/javascript","id":"76526b44-ee08-43df-b76c-02c7f28f1409"}}],"id":"17e71be6-897b-47f4-b9a5-8ad09ebd4e8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportCustomFields\": [\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n },\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n }\n ],\n \"showNsf\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/decisioning/v2/customers/6025984717/preQualVoa","description":"Generate a Prequalification Report (preQualVoa) for all checking, savings, money market, and investment accounts for the given customer. This service retrieves account and owner information as well as the number of NSFs for any account that is a checking account for the customer.
This is a premium service. The billing rate is billed per report for the Prequalification report.
\nBefore calling this API, a consumer must be created for the given customer ID (see Consumers APIs).
\nIf no account of type checking, savings, money market, or investment is found, the service will return HTTP 400 Bad Request.
\nSupported regions:
A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code.
\n","type":"text/plain"},"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[]}},"response":[{"id":"bb65e008-2a27-4d02-9477-bbf3eca8ff89","name":"The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/preQualVoa?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","preQualVoa"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"3d45b75a-8531-4f89-b6fd-8b90f6731e5b","name":"The request was rejected","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/preQualVoa?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","preQualVoa"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"d29f2608-4c54-4ee6-8d91-ff6e4a100fa1","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/preQualVoa?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","preQualVoa"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"945e03f7-9853-4588-9732-e2b40511da1f","name":"The resource doesn't exist","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/preQualVoa?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","preQualVoa"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"}],"_postman_id":"17e71be6-897b-47f4-b9a5-8ad09ebd4e8d"},{"name":"Generate Prequalification (Non-CRA) Report","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([202, 429, 401])\r","})"],"type":"text/javascript","id":"4f8709f5-1824-4e1e-8eb1-b2bec71011aa"}}],"id":"1e6c4575-9f72-4a1a-9cde-14bd1a99ed19","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportCustomFields\": [\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n },\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n }\n ],\n \"showNsf\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/decisioning/v2/customers/6025984717/assetSummary","description":"Retrieve all checking, savings, money market, and investment accounts for a customer. The account, owner information, and the number of insufficient funds (NSFs) for checking accounts are also provided.
\nThis is a premium service, billable per every successful API call.
\nIf no account type of checking, savings, money market, or investment is found, the service will return HTTP 400 Bad Request.
\nSupported regions:
A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code.
\n","type":"text/plain"},"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[]}},"response":[{"id":"3b5d7381-4959-44db-ad70-8ac09bec2c57","name":"The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/assetSummary?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","assetSummary"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"d6b4f568-93f7-457a-9b5c-5c843aebf301","name":"The request was rejected","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/assetSummary?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","assetSummary"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"f46122cd-43c1-4a23-b942-31b2e0bd3329","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/assetSummary?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","assetSummary"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"21d31d81-1300-499e-86e1-3761e9622907","name":"The resource doesn't exist","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/assetSummary?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","assetSummary"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"}],"_postman_id":"1e6c4575-9f72-4a1a-9cde-14bd1a99ed19"}],"id":"242157c9-c4fd-4cf1-b299-3029ff720ad9","description":"Generate asset reports asynchronously
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["// A consumer is needed for some of these APIs","createConsumer()","","function createConsumer() {"," const baseUrl = pm.collectionVariables.get(\"baseUrl\")"," const customerId = pm.environment.get(\"customerId\")"," const appKey = pm.environment.get(\"appKey\")"," const appToken = pm.globals.get(\"appToken\")",""," const consumerExists = pm.globals.get(\"consumerExists\")"," if (consumerExists) {"," // A consumer was already created"," return"," }",""," console.log(\"Creating consumer ... \")"," const options = {"," url: baseUrl + \"/decisioning/v1/customers/\" + customerId + \"/consumer\", "," method: 'POST',"," header: {"," \"Accept\": \"application/json\","," \"Content-type\": \"application/json\","," \"Finicity-App-Key\": appKey,"," \"Finicity-App-Token\": appToken"," },"," body: JSON.stringify({"," \"firstName\": \"Homer\","," \"lastName\": \"Loanseeke\","," \"address\": \"434 W Ascension Way\","," \"city\": \"Murray\","," \"state\": \"UT\","," \"zip\": \"84123\","," \"phone\": \"1-800-986-3343\","," \"ssn\": \"999601111\","," \"birthday\": {"," \"year\": 1970,"," \"month\": 7,"," \"dayOfMonth\": 4"," },"," \"email\": \"finicity@test.com\","," \"suffix\": \"Mr\""," })"," }"," pm.sendRequest(options, function (err, response) {"," pm.expect(err).to.be.null"," pm.expect(response.code).to.be.oneOf([200, 201, 409])"," pm.globals.set(\"consumerExists\", true)"," })","}"],"id":"f6e0359b-e156-4554-8966-d1dcb5d6a273"}}],"_postman_id":"242157c9-c4fd-4cf1-b299-3029ff720ad9"},{"name":"Verify Income and Employment","item":[{"name":"Generate VOI Report","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([202, 429, 401])\r","})"],"type":"text/javascript","id":"26e43d73-c2f1-4b2d-9152-13003ded08ec"}}],"id":"3545608f-b1d8-4134-8f66-897395821d28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportCustomFields\": [\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n },\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n }\n ],\n \"showNsf\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/decisioning/v2/customers/6025984717/voi?callbackUrl=https://finicity-test/webhook","description":"Generate a Verification of Income (VOI) report for all checking, savings, and money market accounts for the given customer. This service retrieves up to two years of transaction history for each account and uses this information to generate the VOI report.
\nThis is a premium service. The billing rate is the variable rate for Verification of Income under the current subscription plan. The billable event is the successful generation of a VOI report.
\nIf no account of type checking, savings, or money market is found, the service will return HTTP 400 Bad Request.
\nSupported regions:
A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code.
\n","type":"text/plain"},"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[]}},"response":[{"id":"e55c4b20-c46c-461e-83ca-379bfe4d142e","name":"The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voi?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voi"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"61d86bf0-ce57-4175-bfa4-b40f692409c5","name":"The request was rejected","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voi?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voi"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"bc0d6978-e6f1-45db-8196-f9de1c9dd435","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voi?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voi"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"bf247b9b-3fe2-4542-a94e-4accfedee3c6","name":"The resource doesn't exist","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voi?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voi"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"}],"_postman_id":"3545608f-b1d8-4134-8f66-897395821d28"},{"name":"Generate VOE - Payroll Report","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([202, 429, 401])\r","})"],"type":"text/javascript","id":"ef7ae37e-cd22-4bfa-9af7-158e23e44172"}}],"id":"a1107c35-6749-4811-b522-e39baffe414c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payrollData\": {\n \"ssn\": \"999601111\",\n \"dob\": 15983999\n },\n \"reportCustomFields\": [\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n },\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/decisioning/v2/customers/6025984717/voePayroll","description":"Premium Service: A billable event when the API response is successful.
\nMVS Implementation Options: Direct API Integration.
\nUsed as a complementary report to the VOIE-Payroll report. This report is used to fulfill the pre-close VOE requirements. It retrieves the customer's employment details and employment status through the payroll source without any income information.
\nTo generate this report, pass the values from the customer SSN, DOB, and the report ID from the first VOIE-Payroll report generated after the Connect session.
\nSupported regions:
A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code.
\n","type":"text/plain"},"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[]}},"response":[{"id":"e6c20eb2-822d-469d-85f6-badf50455e12","name":"The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voePayroll?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voePayroll"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"5866f657-8a20-4d69-9a7d-cf455a2ad8a5","name":"The request was rejected","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voePayroll?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voePayroll"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"cedf1e9e-f170-4555-9f52-dea055622bfe","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voePayroll?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voePayroll"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"9567bece-68b0-4978-b3d2-c0c1d046958a","name":"The resource doesn't exist","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voePayroll?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voePayroll"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"}],"_postman_id":"a1107c35-6749-4811-b522-e39baffe414c"},{"name":"Generate VOE - Transactions Report","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([202, 429, 401])\r","})"],"type":"text/javascript","id":"d6c91e18-cae4-4532-b34b-ade5f1a0c8d2"}}],"id":"c155993b-6415-46bd-9e63-d63a11f107ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportCustomFields\": [\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n },\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n }\n ],\n \"incomeStreamConfidenceMinimum\": 50\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/decisioning/v2/customers/6025984717/voeTransactions","description":"Premium Service: A billable event when the API response is successful.
\nMVS-Direct integration developers only.
\nUsed as a complimentary report to the VOA with Income and VOIE - Paystub (with TXVerify) reports and used to fulfill the pre-close VOE requirements.
\nRetrieve the latest credit transaction information from the borrower's connected bank accounts and groups them into income streams so that you can view their payment history to ensure a direct deport was made within the expected cadence. The report displays transaction descriptions without any dollar amounts so that income re-verification isn't necessary.
\nSupported regions:
A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code.
\n","type":"text/plain"},"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[]}},"response":[{"id":"ab184893-aabc-4815-967d-938fef8dfc1c","name":"The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voeTransactions?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voeTransactions"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"ebcf7e08-0bcf-4504-b295-fe795fe15033","name":"The request was rejected","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voeTransactions?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voeTransactions"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"55966ea1-9e57-4599-af49-ec862a9c6765","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voeTransactions?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voeTransactions"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"0a023e4c-2f7b-4569-a40c-8eb31dd235f1","name":"The resource doesn't exist","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voeTransactions?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voeTransactions"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"}],"_postman_id":"c155993b-6415-46bd-9e63-d63a11f107ad"},{"name":"Generate Pay Statement Report","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([202, 429, 401])\r","})"],"type":"text/javascript","id":"deb17401-11fa-447f-9dfc-c953048a48bc"}}],"id":"515d4e24-951b-478e-aec4-3cbc2621c4fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{\n \"paystatementReport\": {\n \"assetIds\": [\n \"{{assetId}}\"\n ],\n \"extractEarnings\": true,\n \"extractDeductions\": true,\n \"extractDirectDeposit\": true\n },\n \"reportCustomFields\": [\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n },\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/decisioning/v2/customers/6025984717/payStatement","description":"Generate Pay Statement Extraction Report for the given customer. This service accepts asset IDs of the stored pay statements to generate a Pay Statement Extraction Report.
\nThis is a premium service. The billing rate is the variable rate for Pay Statement Extraction Report under the current subscription plan. The billable event is the successful generation of a Pay Statement Extraction Report.
\nSupported regions:
A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code.
\n","type":"text/plain"},"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[]}},"response":[{"id":"680386e8-f0f8-4c6b-8247-af2b778fadee","name":"The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/payStatement?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","payStatement"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"85860a15-5f4a-42a6-92af-ef6aaf02eee2","name":"The request was rejected","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/payStatement?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","payStatement"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"c67a57fd-8210-4f9d-aa32-e35f97d7c5c5","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/payStatement?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","payStatement"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"af6513cc-fae2-40ce-9727-9289fdb890bc","name":"The resource doesn't exist","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/payStatement?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","payStatement"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"}],"_postman_id":"515d4e24-951b-478e-aec4-3cbc2621c4fa"},{"name":"Generate VOIE - Paystub (with TXVerify) Report","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([202, 429, 401])\r","})"],"type":"text/javascript","id":"5d604a60-de85-416f-be58-a04a4366eef5"}}],"id":"30b181b9-f7a0-46b9-9ffe-7c50dd20070f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{\n \"voieWithInterviewData\": {\n \"txVerifyInterview\": [\n {\n \"assetId\": \"{{assetId}}\"\n }\n ],\n \"extractEarnings\": true,\n \"extractDeductions\": true,\n \"extractDirectDeposit\": true\n },\n \"reportCustomFields\": [\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n },\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/decisioning/v2/customers/6025984717/voieTxVerify/withInterview","description":"Generate a VOIE - Paystub (with TXVerify) report for all checking and savings under the given customer. This service retrieves up to two years of transaction history for the given accounts. It then uses this information as well as the provided paystub(s), which are passed into the request body as asset IDs (generated using the Store Customer Pay Statement API) to generate the VOIE - Paystub (with TXVerify) report.
\nNote: if you are using this API to refresh the bank transactions, use the same asset ID from the first report. A new paystub is not required unless the paystub is too old for underwriting requirements. Using the same asset ID that was on the original report and the previously extracted details will be used to speed up report generation response time.
\nThis is a premium service. The billing rate is the variable rate for VOIE TXVerify under the current subscription plan. The billable event is the successful generation of a VOIE TXVerify Report.
\nSupported regions:
A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code.
\n","type":"text/plain"},"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[]}},"response":[{"id":"a5d89656-5ad0-4be0-8364-374e9e507934","name":"The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voieTxVerify/withInterview?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voieTxVerify","withInterview"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"6a13d36d-adc0-4248-97dd-f420443241e8","name":"The request was rejected","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voieTxVerify/withInterview?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voieTxVerify","withInterview"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"cebdacfa-a7f2-47a0-ab8d-36f81c772ca2","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voieTxVerify/withInterview?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voieTxVerify","withInterview"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"aa6de107-40c6-4896-80f6-1a2a1b28acd7","name":"The resource doesn't exist","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voieTxVerify/withInterview?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voieTxVerify","withInterview"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"}],"_postman_id":"30b181b9-f7a0-46b9-9ffe-7c50dd20070f"},{"name":"Generate VOIE - Paystub Report","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([202, 429, 401])\r","})"],"type":"text/javascript","id":"79c5a6c8-6cc7-49c2-9233-07a7fb14a073"}}],"id":"a43ea9ba-35f7-458c-92ea-ccc1b3781641","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{\n \"voieWithStatementData\": {\n \"assetIds\": [\n \"{{assetId}}\"\n ],\n \"extractEarnings\": true,\n \"extractDeductions\": true,\n \"extractDirectDeposit\": true\n },\n \"reportCustomFields\": [\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n },\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/decisioning/v2/customers/6025984717/voieTxVerify/withStatement","description":"Generate a VOIE - Paystub report. This service uses the provided paystub(s), which are passed into the request body as asset IDs (generated using the Store Customer Pay Statement API) to generate the VOIE - Paystub report with digitized paystub details.
\nThis is a premium service. The billing rate is the variable rate for VOIE - Paystub under the current subscription plan. The billable event is the successful generation of a VOIE - Paystub Report.
\nSupported regions:
A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code.
\n","type":"text/plain"},"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[]}},"response":[{"id":"27de3737-dc1e-4166-990a-6d76fcd74865","name":"The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voieTxVerify/withStatement?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voieTxVerify","withStatement"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"518d093e-50b7-4852-b72c-ac8e4e5ff62d","name":"The request was rejected","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voieTxVerify/withStatement?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voieTxVerify","withStatement"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"4752d147-0c79-42e6-9239-78fe075556a1","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voieTxVerify/withStatement?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voieTxVerify","withStatement"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"1650d68a-682f-4f4b-84ae-1a166ca66a89","name":"The resource doesn't exist","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voieTxVerify/withStatement?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voieTxVerify","withStatement"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"}],"_postman_id":"a43ea9ba-35f7-458c-92ea-ccc1b3781641"},{"name":"Refresh VOIE - Payroll Report","event":[{"listen":"test","script":{"exec":["pm.test(\"Check status code\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([202, 429, 401])\r","})"],"type":"text/javascript","id":"d08744a4-3415-4ba9-bb07-8bdfa9cbfafb"}}],"id":"55f2a0f7-9910-4837-be35-f672aa841168","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"},{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payrollData\": {\n \"ssn\": \"999601111\",\n \"dob\": 15983999\n },\n \"reportCustomFields\": [\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n },\n {\n \"label\": \"loanID\",\n \"value\": \"123456\",\n \"shown\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.finicity.com/decisioning/v2/customers/6025984717/voiePayroll","description":"The VOIE β Payroll report generates when the customer completes Connect. Lenders, who commonly use this report for pre-close verification employment check, can refresh this report by passing the consumer's SSN, DOB, and the report ID from the first VOIE β Payroll report they received.
\nWe'll refresh this report and update any new pay histories since the first report generated, including borrower's employment status as active or not.
\nNote: lenders can only refresh this report one time in a 60-day period starting from the date of the first report. Any further report refreshes will incur additional charges.
\nSupported regions:
A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code.
\n","type":"text/plain"},"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[]}},"response":[{"id":"8a4ecdfd-e7e4-48bf-9830-31ae28ae07ea","name":"The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voiePayroll?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voiePayroll"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"b3f41937-52a5-4ad3-a5d6-6279d023e309","name":"The request was rejected","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voiePayroll?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voiePayroll"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}"},{"id":"84f238fd-cb6b-4aea-83d7-8c4cf2498327","name":"The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voiePayroll?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voiePayroll"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}"},{"id":"557b3bc9-e865-4cef-b2a3-db25703abcaf","name":"The resource doesn't exist","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec"}],"url":{"raw":"https://api.finicity.com/decisioning/v2/customers/:customerId/voiePayroll?callbackUrl=https://finicity-test/webhook","host":["https://api.finicity.com"],"path":["decisioning","v2","customers",":customerId","voiePayroll"],"query":[{"key":"callbackUrl","value":"https://finicity-test/webhook"}],"variable":[{"key":"customerId","value":"1005061234","description":"(Required) A customer ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}"}],"_postman_id":"55f2a0f7-9910-4837-be35-f672aa841168"}],"id":"1de62e11-2804-4d3d-9738-674abaec6609","description":"Generate income and employment reports asynchronously
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["const baseUrl = pm.collectionVariables.get(\"baseUrl\")","const appKey = pm.environment.get(\"appKey\")","const customerId = pm.environment.get(\"customerId\")","const appToken = pm.globals.get(\"appToken\")","","// A consumer is needed for some of these APIs","createConsumer()","createAsset()","","function createAsset() {"," const assetId = pm.variables.get(\"assetId\")"," if (assetId) {"," return"," }",""," console.log(\"Creating asset ID ...\")"," const options = {"," url: baseUrl + \"/aggregation/v1/customers/\"+ customerId + \"/payStatements\","," method: 'POST',"," header: {"," \"Accept\": \"application/json\","," \"Content-Type\": \"application/json\","," \"Finicity-App-Key\": appKey,"," \"Finicity-App-Token\": appToken"," },"," body: JSON.stringify({"," \"label\": \"lastPayPeriod\","," \"statement\": \"VGhpcyBtdXN0IGJlIGFuIGltYWdl\""," })"," }"," pm.sendRequest(options, function (err, response) {"," pm.expect(err).to.be.null"," pm.expect(response.code).to.equals(200)"," pm.variables.set(\"assetId\", response.json().assetId)"," })","}","","function createConsumer() {"," const consumerExists = pm.globals.get(\"consumerExists\")"," if (consumerExists) {"," // A consumer was already created"," return"," }",""," console.log(\"Creating consumer ... \")"," const options = {"," url: baseUrl + \"/decisioning/v1/customers/\" + customerId + \"/consumer\", "," method: 'POST',"," header: {"," \"Accept\": \"application/json\","," \"Content-type\": \"application/json\","," \"Finicity-App-Key\": appKey,"," \"Finicity-App-Token\": appToken"," },"," body: JSON.stringify({"," \"firstName\": \"Homer\","," \"lastName\": \"Loanseeke\","," \"address\": \"434 W Ascension Way\","," \"city\": \"Murray\","," \"state\": \"UT\","," \"zip\": \"84123\","," \"phone\": \"1-800-986-3343\","," \"ssn\": \"999601111\","," \"birthday\": {"," \"year\": 1970,"," \"month\": 7,"," \"dayOfMonth\": 4"," },"," \"email\": \"finicity@test.com\","," \"suffix\": \"Mr\""," })"," }"," pm.sendRequest(options, function (err, response) {"," pm.expect(err).to.be.null"," pm.expect(response.code).to.be.oneOf([200, 201, 409])"," pm.globals.set(\"consumerExists\", true)"," })","}"],"id":"e3f4d600-d483-4fcc-b8ec-6b6abf2c8cb5"}}],"_postman_id":"1de62e11-2804-4d3d-9738-674abaec6609"}],"id":"97c600ca-f8c1-4eab-9230-20a770296162","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["console.log(pm.info.requestName + \" ...\")","","// Generate a new access token every 90 minutes","const baseUrl = pm.collectionVariables.get(\"baseUrl\")","const partnerId = pm.environment.get(\"partnerId\")","const partnerSecret = pm.environment.get(\"partnerSecret\")","const appKey = pm.environment.get(\"appKey\")","const appToken = pm.globals.get(\"appToken\")","","const now = new Date()","const expiryDate = appToken ? new Date(pm.globals.get(\"appTokenExpiry\")) : now","if (appToken && expiryDate > now) {"," // The token is still valid"," return","}","","// Create a new token","console.log(\"Creating access token ...\")","const options = {"," url: baseUrl + \"/aggregation/v2/partners/authentication\", "," method: 'POST',"," header: {"," \"Accept\": \"application/json\","," \"Content-type\": \"application/json\","," \"Finicity-App-Key\": appKey"," },"," body: JSON.stringify({"," \"partnerId\": partnerId,"," \"partnerSecret\": partnerSecret"," })","}","pm.sendRequest(options, function (err, response) {"," if (response.code == 403) {"," throw Error(\"HTTP 403. Make sure you are located in the US, UK or Canada.\")"," }"," pm.expect(err).to.be.null"," pm.expect(response.code).to.equals(200)"," const tokenValue = response.json().token"," const expiryDate = new Date()"," expiryDate.setMinutes(expiryDate.getMinutes() + 90)"," pm.globals.set(\"appToken\", tokenValue)"," pm.globals.set(\"appTokenExpiry\", expiryDate)","})"],"id":"6ec5ab0a-846f-4a04-8627-740d73801943"}}],"_postman_id":"97c600ca-f8c1-4eab-9230-20a770296162","description":""},{"name":"CF API","item":[{"name":"Create Customer","id":"a6122a6d-dfc8-4a0c-9081-6cbd24ec26f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"username\":\"customer_Vimal\",\r\n \"firstName\":\"F name\",\r\n \"lastName\":\"L name\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://pay-management.psvimal33329.workers.dev/createCustomer","urlObject":{"path":["createCustomer"],"host":["https://pay-management.psvimal33329.workers.dev"],"query":[],"variable":[]}},"response":[],"_postman_id":"a6122a6d-dfc8-4a0c-9081-6cbd24ec26f3"},{"name":"Getlink","id":"d16121d9-51c7-41a4-be77-648774a37bf8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\":\"6025984717\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://pay-management.psvimal33329.workers.dev/MaterConfig","urlObject":{"path":["MaterConfig"],"host":["https://pay-management.psvimal33329.workers.dev"],"query":[],"variable":[]}},"response":[],"_postman_id":"d16121d9-51c7-41a4-be77-648774a37bf8"},{"name":"View Account","id":"29d8386d-e32d-457d-a0a9-780335fe3699","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\":\"6025984717\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://pay-management.psvimal33329.workers.dev/ViewAccount","urlObject":{"path":["ViewAccount"],"host":["https://pay-management.psvimal33329.workers.dev"],"query":[],"variable":[]}},"response":[],"_postman_id":"29d8386d-e32d-457d-a0a9-780335fe3699"},{"name":"View Main Transcation","id":"ad442f4e-7039-4260-805d-f7dbab894c2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\":\"6025984717\",\r\n \"fromDate\":1640995200,\r\n \"toDate\":1664620799\r\n}","options":{"raw":{"language":"json"}}},"url":"https://pay-management.psvimal33329.workers.dev/GetTranscation","urlObject":{"path":["GetTranscation"],"host":["https://pay-management.psvimal33329.workers.dev"],"query":[],"variable":[]}},"response":[],"_postman_id":"ad442f4e-7039-4260-805d-f7dbab894c2f"},{"name":"View Formance Transcation","id":"cdc74e2f-8475-4bdc-a057-e4902a55b04b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ledger\":\"default\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://pay-management.psvimal33329.workers.dev/formanceTransaction","urlObject":{"path":["formanceTransaction"],"host":["https://pay-management.psvimal33329.workers.dev"],"query":[],"variable":[]}},"response":[],"_postman_id":"cdc74e2f-8475-4bdc-a057-e4902a55b04b"},{"name":"Add Formance Transcation","id":"fd2b03bb-c5dd-495f-bdaf-67f4d0412561","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Finicity-App-Key","value":"0da767cc941033f5c5bb2ebec643feec","type":"text"},{"key":"Finicity-App-Token","value":"{{appToken}}","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"source\":\"world\",\r\n \"destination\":\"destination\",\r\n \"amount\":200,\r\n \"ledger\":\"default\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://pay-management.psvimal33329.workers.dev/addTransaction","urlObject":{"path":["addTransaction"],"host":["https://pay-management.psvimal33329.workers.dev"],"query":[],"variable":[]}},"response":[],"_postman_id":"fd2b03bb-c5dd-495f-bdaf-67f4d0412561"}],"id":"a9ac6c78-e3a7-4d15-a9ee-6cc559676ec5","_postman_id":"a9ac6c78-e3a7-4d15-a9ee-6cc559676ec5","description":""}],"event":[{"listen":"prerequest","script":{"id":"c776be63-6454-48d7-8f97-f4d3f177b49e","type":"text/javascript","exec":["var moment = require('moment');","var ISO_8601_OFFSET = 'YYYY-MM-DDTHH:mm:ss.SSS';","pm.environment.set(\"nowIso8601\", `${moment().format(ISO_8601_OFFSET)}Z`);","pm.environment.set(\"tomorrowIso8601\", `${moment().add(1, 'days').format(ISO_8601_OFFSET)}Z`);"]}},{"listen":"test","script":{"id":"6f1bffec-db81-4ad4-b866-6adecc6e057c","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://api.finicity.com"},{"key":"appKey","value":"0da767cc941033f5c5bb2ebec643feec"},{"key":"partnerId","value":"2445584195057","type":"string"},{"key":"partnerSecret","value":"Xb0dkA6h9fXn5gqLkfrI","type":"string"},{"key":"customerId","value":"6025984717","type":"string"},{"key":"CFURL","value":"https://pay-management.psvimal33329.workers.dev","type":"string"},{"key":"CFURL","value":"http://192.168.107.1:55160","type":"string","disabled":true},{"key":"fromDate","value":"1640995200","type":"string"},{"key":"toDate","value":"1664620799","type":"string"}]}