added
Supported APIs:
- Generate V2 Connect Full / Lite
Supported processes:
- VOA
- VOAI
- VOI
- Aggregation
- ACH
Description: Sent after the user lands on the Eligible accounts page to select which accounts to use as the source of their financial information, and clicks Submit. The accounts are saved in the account’s resource associated with the customer.
Note: If the institution is an OAuth connection, the ouath parameter value is true.
{
"customerId": "1017101354",
"eventType": "added",
"eventId": "1611877956869-28ebb24c66699bf3c77f04b1",
"payload": {
"accounts": [
{
"id": "1045121390",
"number": "1000001111",
"realAccountNumberLast4": "1111",
"accountNumberDisplay": "1111",
"name": "Checking",
"balance": 128.52,
"type": "checking",
"aggregationStatusCode": 0,
"status": "active",
"customerId": "1017101354",
"institutionId": "101732",
"balanceDate": 1611877952,
"aggregationSuccessDate": 1611877953,
"aggregationAttemptDate": 1611877953,
"createdDate": 1608197223,
"lastUpdatedDate": 1611877956,
"currency": "USD",
"lastTransactionDate": 1611357151,
"institutionLoginId": 1022599285,
"detail": {
"availableBalanceAmount": 122.12,
"periodInterestRate": "4.5"
},
"displayPosition": 5
},
{
"id": "1045121391",
"number": "1000002222",
"realAccountNumberLast4": "2222",
"accountNumberDisplay": "2222",
"name": "Savings",
"balance": 128.52,
"type": "savings",
"aggregationStatusCode": 0,
"status": "active",
"customerId": "1017101354",
"institutionId": "101732",
"balanceDate": 1611877952,
"aggregationSuccessDate": 1611877953,
"aggregationAttemptDate": 1611877953,
"createdDate": 1608197223,
"lastUpdatedDate": 1611877956,
"currency": "USD",
"lastTransactionDate": 1608197228,
"institutionLoginId": 1022599285,
"detail": {
"availableBalanceAmount": 1217.27,
"periodInterestRate": "4.5"
},
"displayPosition": 6
}
],
"institutionId": "101732"
}
} adding
Supported APIs:
- Generate V2 Connect Full / Lite
Supported processes:
- VOA
- VOAI
- VOI
- Aggregation
- ACH
Description: Sent when a customer enters their sign-in information at a financial institution and selects which accounts Connect can access to verify their financial information.
Note: If the institution is an OAuth connection, the oauth parameter value is true.
{
"customerId": "7065940",
"eventType": "adding",
"eventId": "1572413263805-b43cb6edb3254d4bebcfb4a0",
"payload": {
"institutionId": "102224",
"oauth": true
}
} credentialsUpdated
Supported APIs:
- Generate V2 Connect Fix
- OAuth, not support
Description: Sent when the customer updates their sign-in information for a selected institution. The mfa field indicates whether the credential challenge was followed by a sequential true or false MFA challenge question.
{
"customerId": "29272504",
"consumerId": "41d42ef0faef200e370208ad179a44cd",
"eventType": "credentialsUpdated",
"eventId": "1559073542901-f2d2ebd11cf852a8114b54dc",
"payload": {
"institutionId": "101732",
"mfa": false
}
} discovered
Supported APIs:
- Generate V2 Connect Full / Lite / Fix
- OAuth, not supported
Supported processes:
- VOA
- VOAI
- VOI
- Aggregation
- ACH
Description: Sent after the customer has successfully signed into an institution. All the accounts that the user can select from are included in this event. The accounts in the payload of the subsequently added event are a subset of the accounts in the discovered event. If no accounts were discovered, then an empty array is sent.
{
"customerId": "29272504"
"consumerId": "41d42ef0faef200e370208ad179a44cd"
"eventType": "discovered",
"eventId": "1543509870615-7db10ceac8b2f5fa9b7b078c",
"payload": {
"accounts": [
"...",
"..."
]
}
} documentUpload
Supported APIs:
- Generate V2 Connect Full/ Lite / Send Email / Fix
- Connect Full – Joint Borrowers
- Send Connect Email – Joint Borrowers
Supported processes:
- VOIE – Paystub (with TXVerify)
Description: Sent after the user uploads a document in Connect.
{
"consumerId": "9a6f18zzz219a49d7f198a5ea6d959371",
"customerId": "52906923",
"eventType": "documentUpload",
"eventId": "157652800zzz-5a1zzzzdb38df8a07915863305",
"payload": {
"assets": [
{
"assetId": "257zzzac-7712-45a6-b895-8132fc88011d",
"label": "lastPayPeriod"
},
{
"assetId": "c36zzz0f-6519-4185-aa9e-768461a7c776",
"label": "lastPayPeriod"
}
]
}
} done
Supported APIs:
- Generate V2 Connect Full/ Lite / Send Email / Fix
- Connect Full – Joint Borrowers
- Send Connect Email – Joint Borrowers
Supported processes:
- VOA
- VOAI
- VOI
- Aggregation
- ACH
- VOIE – Payroll
- VOIE – Paystub (with TXVerify)
Description: Sent after all pending reports are completed.
Aggregation
type = aggregation
Description: Sent after the user clicks Submit at the end of the Connect application.
{
"customerId": "29272504",
"consumerId": "41d42ef0faef200e370208ad179a44cd",
"eventType": "done",
"payload": {}
} done (reports)
Supported APIs:
- Generate V2 Connect Full / Lite / Send Email / Fix
- Connect Full – Joint Borrowers
- Send Connect Email – Joint Borrowers
Supported processes:
- VOA
- VOAI
- VOI
- Aggregation
- ACH
- VOIE – Payroll
- VOIE – Paystub (with TXVerify)
Description: Sent after all pending reports are completed. If you request more than one report, the payload is an array of information for each report requested.
{
"eventType": "done"
"customerId": "50372071",
"eventId": "1571149759962-bbf047aa3304f77dcbaf3e23",
"payload": [{
"eventName":"done",
"id":"uq1scf3cvu9a",
"consumerId":"382abd9cea1df5745772171a24d6ea6d",
"consumerSsn":"3333",
"type":"voa",
"customerId": "50372071",
"status":"success",
"portfolioId":"ixfmmzyasdc0-1-port"
}]
} employerFound
Supported APIs:
- Generate V2 Connect Full /Send Email
- Connect Full – Joint Borrowers
- Send Connect Email – Joint Borrowers
Supported processes:
- VOIE – Payroll
Description: Sent when employment records matching the customer’s Social Security number (SSN) and date of birth (DOB) are found in the payroll providers.
{
"customerId": "1013916100",
"consumerId": "06a46d02b9851829ca53946be1da8200",
"eventType": "employerFound",
"eventId": "1602696485261-d299df6440556091e1d0531c",
"payload": {
"numEmployers": 1
}
} employerNotFound
Supported APIs:
- Generate V2 Connect Full / Send Email
- Connect Full – Joint Borrowers
- Send Connect Email – Joint Borrowers
Supported processes:
- VOIE – Payroll
Description: Sent when the customer’s SSN and DOB don’t match any employment records from the payroll provider.
{
"customerId": "1013916100",
"consumerId": "06a46d02b9851829ca53946be1da8200",
"eventType": "employerNotFound",
"eventId": "1602696889157-e6adbb438604041fc39ab3dd",
"payload": {
"error": 404,
"message": "Employment data not found"
}
} failed
Supported APIs:
- Generate V2 Connect Full / Send Email
- Connect Full – Joint Borrowers
- Send Connect Email – Joint Borrowers
Supported processes:
- VOA
- VOAI
- VOI
- Prequalification VOA
- VOIE – Payroll
- VOIE – Paystub (with TXVerify)
Description: Sent after a report has failed to generate.
{
"id":"reportId",
"eventName": "failed",
"consumerId": "conId",
"consumerSsn": "conSSN",
"type": "reportType",
"status": "failure",
"customerId": 123,
"portfolioId": "asdf-1-port"
} generating
Supported APIs:
- Generate V2 Connect Full / Send Email
- Connect Full – Joint Borrowers
- Send Connect Email – Joint Borrowers
Supported processes:
- VOA
- VOAI
- VOI
- Prequalification VOA
- VOIE – Payroll
- VOIE – Paystub (with TXVerify)
Description: Sent when the verification report starts generating. If you request more than one report, the payload is an array of information for each report.
{
"customerId":"1013916100",
"consumerId":"06a46d02b9851829ca53946be1da8200",
"eventType":"generating",
"eventId":"1602704867988-65267fe1419ac4f7f9f6876c",
"payload":[
{
"reportId":"11y30qep6hdf-voiepayrollprovider",
"type":"voiePayrollProvider",
"status":"inProgress",
"requesterName":"Finicity",
"source":"Finicity Connect",
"portfolioId":"11sersekhucz-1-port",
"customerType":"testing",
"customerId":1014170130,
"requestId":"47ibyf7g4h",
"createdDate":1602704867,
"title":"Finicity Verification of Income and Employment - Payroll",
"consumerId":"8b43c0ed60e9177feecbfd9aaf27c356",
"consumerSsn":"6789",
"constraints":{
"payrollProviderData":[
{
"payrollDataRetrievalId":"1188txzmdbj0",
"employerNames":[
"TWINWOODS TRANSPORTATION INC"
]
}
]
}
},
{
"reportId":"11y30qep6h45",
"type":"voaHistory",
"status":"inProgress",
"requesterName":"Finicity",
"source":"Finicity Connect",
"portfolioId":"11sersekhucz-2-port",
"customerType":"testing",
"customerId":1014170130,
"requestId":"47ibyf7g4h",
"createdDate":1602704867,
"title":"Finicity Verification of Asset and Income - Payroll",
"consumerId":"8b43c0ed60e9177feecbfd9aaf27c356",
"consumerSsn":"6789",
"constraints":{
}
},
{
"reportId":"11y30qep6hdf-voieTxVerify",
"type":"voieTxVerify",
"status":"inProgress",
"requesterName":"Finicity",
"source":"Finicity Connect",
"portfolioId":"11sersekhucz-3-port",
"customerType":"testing",
"customerId":1014170130,
"requestId":"47ibyf7g4h",
"createdDate":1602704867,
"title":"Finicity Verification of Income and Employment - Paystub (with TXVerify)",
"consumerId":"8b43c0ed60e9177feecbfd9aaf27c356",
"consumerSsn":"6789",
"constraints":{
"voieWithInterviewData":{
"txVerifyInterview":[
{ inProgress
Supported APIs:
- Generate V2 Connect Full / Send Email
- Connect Full – Joint Borrowers
- Send Connect Email – Joint Borrowers
Supported processes:
- VOA
- VOAI
- VOI
- Prequalification VOA
- VOIE – Payroll
- VOIE – Paystub (with TXVerify)
Description: Sent when a report is being generated and has an inProgress status.
{
"id":"reportId",
"eventName": "inProgress",
"consumerId": "conId",
"consumerSsn": "conSSN",
"type": "reportType",
"status": "inProgress",
"customerId": 123,
"portfolioId": "asdf-1-port"
} institutionNotFound
Supported APIs:
Supported processes:
- VOA
- VOAI
- VOI
- Aggregation
- ACH
Description: Sent when the user searches for an institution that is not on our list. Connect provides the description for the query field.
{
"customerId": "29272504",
"eventType": "institutionNotFound",
"eventId": "1564677197519-4f47b664bd855275389e76c6",
"payload": {
"query": "not a real institution"
}
} institutionNotSupported
Supported APIs:
- Generate V2 Connect Full / Lite / Fix
Supported processes:
- VOA
- VOAI
- VOI
- Aggregation
- ACH
Description: Sent when the user selects an institution that isn’t certified. This applies to any call except for aggregation/lite/fix/voi-pp.
{
"customerId": "29272504",
"consumerId": "41d42ef0faef200e370208ad179a44cd",
"eventType": "institutionNotSupported",
"eventId": "1543535415162-6d06cbeed93533d612b4e255",
"payload": {
"institutionId": "15880"
}
} institutionSupported
Supported APIs:
- Generate V2 Connect Full / Lite
Supported processes:
- VOA
- VOAI
- VOI
- Aggregation
- ACH
Description: Sent when a user selects a financial institution from a search query that is certified for the product.
{
"customerId": "29272504",
"consumerId": "41d42ef0faef200e370208ad179a44cd",
"eventType": "institutionSupported",
"eventId": "1557155470294-f5e5273c2354e09670647e18",
"payload": {
"institutionId": "101732"
}
} invalidCredentials
Supported APIs:
- Generate V2 Connect Full / Lite / Fix
- OAuth, not supported
Supported processes:
- VOA
- VOAI
- VOI
- Aggregation
- ACH
Description: Sent when the user enters incorrect sign-in information for the selected institution.
{
"customerId": "29272504",
"consumerId": "41d42ef0faef200e370208ad179a44cd",
"eventType": "invalidCredentials",
"eventId": "1543535972345-805ba937fdc4c6d3889b261c",
"payload": {
"institutionId": "101732"
}
} mfa
Supported APIs:
- Generate V2 Connect Full / Lite
- OAuth, not supported
Supported processes:
- VOA
- VOAI
- VOI
- Aggregation
- ACH
Description: Sent when the user enters correct sign-in information for an institution, and then a Multi-Factor Authorization (MFA) challenge question displays.
{
"customerId": "29272504",
"consumerId": "41d42ef0faef200e370208ad179a44cd",
"eventType": "mfa",
"eventId": "1543535689086-56219127a30d3f881436c0b2",
"payload": {
"institutionId": "101732"
}
} mfaUpdated
Supported APIs:
- Generate V2 Connect Fix
- OAuth, not supported
Description: Sent when the user completes the MFA challenge question for an institution.
{
"customerId": "29272504",
"eventType": "mfaUpdated",
"eventId": "1559073793752-914b6150eacc1d59fe444bf3",
"payload": {
"institutionId": "101732"
}
} payrollError
Supported APIs:
- Generate V2 Connect Full / Send Email
- Connect Full – Joint Borrowers
- Send Connect Email – Joint Borrowers
Supported processes:
- VOIE – Payroll
Description: This event is sent when an error occurs while making a request to the payroll connector service. The error code and message are included in the response payload.
400 error: The consumer record doesn’t match the Social Security number (SSN) and date of birth (DOB) passed to Connect.
500 error: An unexpected error has occurred.
{
"customerId": "1013916100",
"consumerId": "06a46d02b9851829ca53946be1da8200",
"eventType": "payrollError”,
"eventId": "1602696010692-ac29d9e8e1dbeee869e1b46d",
"payload": {
"error": 400,
"message": "Please provide valid ssn and date of Birth for customer 1013916100"
}
} payrollSearch
Supported APIs:
- Generate V2 Connect Full / Send Email
- Connect Full – Joint Borrowers
- Send Connect Email – Joint Borrowers
Supported processes:
- VOIE – Payroll
Description: Sent when the customer enters their SSN and DOB to search for their payroll information.
{
"customerId": "1013916100",
"consumerId": "06a46d02b9851829ca53946be1da8200",
"eventType": "payrollSearch",
"eventId": "1602696009983-f18edc8d007efc7d4f87000e",
"payload": {
"ssn": "6789",
"dateOfBirth": "1980-01-01"
}
} ping
Supported APIs:
- Generate V2 Connect Full / Lite / Send Email / Fix
- Connect Full – Joint Borrowers
- Send Connect Email – Joint Borrowers
Supported processes:
- VOA
- VOAI
- VOI
- Aggregation
- ACH
- VOIE – Payroll
- VOIE – Paystub (with TXVerify)
Description: Sent when the Generate 2.0 Connect URL APIs are called to verify that the webhook URL is accessible. This endpoint must return a 200 series or the Generate Finicity Connect URL call will fail.
{
"eventType":ping
"Payload": []
} primaryFieldUpdate
Supported APIs
Supported processes:
- VOIE – Paystub (with TXverify)
Description:
{
"customerId": "1017101354",
"eventType": "primaryFieldUpdate",
"eventId": "1611878154698-6e07f324cd4675659317feec",
"payload": [
{
"eventName": "primaryFieldUpdate",
"id": "03yi1i0x6495-voietxverify",
"consumerId": "c40857ef334ade651b0473e7a980f7eb",
"consumerSsn": "0000",
"type": "voieTxVerify",
"status": "success",
"portfolioId": "y35xarmnu92q-18-port",
"customerId": 1017101354
}
]
} processing
Supported APIs:
- Generate V2 Connect Full / Lite / Fix
Supported processes:
- VOA
- VOAI
- VOI
- Aggregation
- ACH
Descriptions: Sent when a request to generate a report is in the process of generating the report.
(OAuth) Sent after the user selects their accounts from an OAuth connection and is redirected back to Connect.
{
"customerId": "7065940",
"eventType": "processing",
"eventId": "1567184715231-20b2b26125f0e7ada97395cb",
"Payload": {
"institutionId":"102224"
}
} started
Supported APIs:
- Generate V2 Connect Full / Lite / Send Email / Fix
- Connect Full – Joint Borrowers
- Send Connect Email – Joint Borrowers
Supported processes:
- VOA
- VOAI
- VOI
- Aggregation
- ACH
- VOIE – Payroll
- VOIE – Paystub (with TXVerify)
Description Sent when the Connect application is loaded and the landing web page is displayed.
{
"customerId": "1013916100",
"consumerId": "06a46d02b9851829ca53946be1da8200",
"eventType": "started",
"eventId": "1602695997415-9acf8c53accecf433bc8b000",
"payload": {}
} unableToConnect
Supported APIs:
- Generate V2 Connect Full / Lite / Send Email
- Connect Full – Joint Borrowers
- Send Connect Email – Joint Borrowers
Supported processes:
- VOA
- VOAI
- VOI
- Aggregation
- ACH
- VOIE – Payroll
Description: Sent when a financial institution is having availability issues and a connection isn’t possible.
Error codes: 102, 500, 900, 903, 904, 901, 910, 915, 916, and 920.
{
"customerId": "29272504",
"consumerId": "41d42ef0faef200e370208ad179a44cd",
"eventType": "unableToConnect",
"eventId": "1543535415162-6d06cbeed93533d612b4e255",
"payload": {
"institutionId": "15880"
"code": 500
}
}