> ## Documentation Index
> Fetch the complete documentation index at: https://docs.argyle.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Credit bureau workflows
> Retrieve a user-permissioned employment report from a credit bureau.
Credit bureau workflows is a fail-safe for users whose income details fall outside the scope of Argyle's real-time, continuous data solutions—as well as for businesses specifically requiring legacy credit bureau data sets.
You can deploy credit bureau workflows instead of (or in addition to) [document upload & processing](/workflows/document-processing). Even better, credit bureau workflows are also fully embedded in Argyle Link making it your one-stop shop for all things VoIE.
Credit bureau workflows are currently available on Web Link only.
## User experience
Argyle allows you to deep link your users to an SSN and DOB entry screen in Argyle Link. You can achieve this by initializing Link with the optional `creditBureauFlow` parameter set to `true`. When the user has successfully submitted their information, the details are encrypted and passed to a credit bureau.
## Implement credit bureau workflows
With Argyle's credit bureau workflows you no longer have to develop and maintain an in-house solution. Argyle has taken care of both back- and front-end integration, which you can leverage using your existing credit bureau arrangements and Argyle Link.
### Authentication
Argyle recommends creating a dedicated set of credentials for this integration. Argyle will then encrypt these and your client certificate with [Google KMS](https://cloud.google.com/security-key-management). Read more about how Argyle handles security and compliance [here](https://argyle.com/legal/security/).
### Sequence
The Argyle API directly passes data retrieved from a credit bureau. This is what the process looks like:
You can also subscribe to the `onCreditBureauFormSubmitted(accountId, userId)` callback, which is invoked when a user submits the SSN and DOB.
## View data returned by a credit bureau
### API
Retrieve data by calling Argyle's [`/forms`](/legacy/api-reference/forms) endpoint. When you retrieve forms by [account ID](/legacy/api-reference/accounts#object-id), the Argyle API provides the credit bureau data in the optional `data` object. It includes user input fields `ssn`, `date_of_birth` alongside a `verification_result` object representing data obtained from a credit bureau's API (XML is always converted to JSON).
#### Forms endpoint JSON response:
```json theme={}
{
"id": "018203b4-e504-2f00-9920-660fba29e2d8",
"template": "0181fd05-1a37-9537-06e3-339e335c191a",
"version": "0",
"status": "submitted",
"data": {
"ssn": "123456789",
"date_of_birth": "1987-07-07"
"verification_result": {
"OFX": {
"...VoIE data provided by a credit bureau"
}
}
},
"created_at": "2022-07-15T21:12:43.017Z",
"updated_at": "2022-07-15T21:55:24.853Z"
}
```
#### Sample credit bureau XML payload:
```xml theme={}
{
"id":"018203b4-e504-2f00-9920-660fba29e2d8",
"template":"0181fd05-1a37-9537-06e3-339e335c191a",
"version":"0",
"status":"in_progress",
"data":{
"ssn":"999001147",
"date_of_birth":"2022-12-31",
"verification_result":{
"OFX":{
"TSVERMSGSRSV1":{
"TSVTWNSELECTTRNRS":{
"STATUS":{
"CODE":0,
"SEVERITY":"INFO"
},
"TRNUID":123456789,
"TRNPURPOSE":{
"CODE":"PPCREDIT",
"MESSAGE":"Consumer's application for credit"
},
"MASTERSRVRTID":984567593775,
"TSVTWNSELECTRS":{
"TSVRESPONSE_V100":[
{
"DEMOTRN":{
"DEMOTYPE":"Employer"
},
"SRVRTID":984567593776,
"TSVBASECOMP":{
"TSVRATEOFPAY":400,
"TSVAVGHRSWORKED":40,
"TSVPAYFREQUENCY":{
"CODE":8,
"MESSAGE":"Daily"
},
"TSVPAYPERIODFREQUENCY":{
"CODE":7,
"MESSAGE":"Weekly"
}
},
"COMPLETENESS":"INCOME",
"DTTRANSACTION":20220727084353,
"TSVANNUALCOMP":[
{
"TSVYEAR":2022,
"TSVTOTAL":57208.5
},
{
"TSVYEAR":2021,
"TSVTOTAL":99887.65
},
{
"TSVYEAR":2020,
"TSVTOTAL":94838.89
}
],
"TSVPROJINCOME":104000,
"TSVEMPLOYEE_V100":{
"SSN":999001147,
"DTINFO":20220715000000,
"LASTNAME":"SEA",
"FIRSTNAME":"Jess",
"MIDDLENAME":"X",
"EMPLOYEESTATUS":{
"CODE":9,
"MESSAGE":"On Leave"
},
"POSITION-TITLE":"DEMO EMPLOYEE",
"DTENDEMPLOYMENT":"",
"DTMOSTRECENTHIRE":19990205000000,
"TOTALLENGTHOFSVC":282
},
"TSVEMPLOYER_V100":{
"NAME1":"Enterprise USA",
"DISCLAIMER":"employer: Should the employer provide a disclaimer, it will appear here: This is your test VOI 91001 employer disclaimer. Thank you",
"EMPLOYERCODE":91001,
"EMPLOYERDISPLAY":{
"EMPLOYERDISPLAYINFO":{
"LANGUAGE":"ENG",
"LOGOFILENAME":"https://secure1.verifier.theworknumber.com/resources/images/company_logos/91001.gif",
"VOICEFILENAME":""
}
},
"ITEMIZEDDISCLAIMERS":{
"DISCLAIMERTEXT":"Should the employer provide a disclaimer, it will appear here: This is your test VOI 91001 employer disclaimer. Thank you",
"DISCLAIMERTYPE":"ER"
}
}
},
{
"DEMOTRN":{
"DEMOTYPE":""
},
"SRVRTID":984567593777,
"TSVBASECOMP":{
"TSVRATEOFPAY":15,
"TSVAVGHRSWORKED":"",
"TSVPAYFREQUENCY":{
"CODE":9,
"MESSAGE":"Hourly"
},
"TSVPAYPERIODFREQUENCY":{
"CODE":6,
"MESSAGE":"Biweekly"
}
},
"COMPLETENESS":"INCOME",
"DTTRANSACTION":20220727084353,
"TSVANNUALCOMP":[
{
"TSVYEAR":2022,
"TSVTOTAL":8175.88
},
{
"TSVYEAR":2021,
"TSVTOTAL":895.05
}
],
"TSVPROJINCOME":41447.17,
"TSVEMPLOYEE_V100":{
"SSN":999001147,
"DTINFO":20220408000000,
"LASTNAME":"Gonzales Benza",
"FIRSTNAME":"Renato",
"MIDDLENAME":"",
"EMPLOYEESTATUS":{
"CODE":8,
"MESSAGE":"Inactive"
},
"POSITION-TITLE":"Lift Operator",
"DTENDEMPLOYMENT":20220313000000,
"DTMOSTRECENTHIRE":20211213000000,
"TOTALLENGTHOFSVC":3
},
"TSVEMPLOYER_V100":{
"NAME1":"Vail Corporation",
"DISCLAIMER":"employer:Garnishment requests should be sent to: Vail Resorts, Inc. Attention Payroll 390 Interlocken Crescent Broomfield, CO 80021",
"EMPLOYERCODE":14760,
"EMPLOYERDISPLAY":{
"EMPLOYERDISPLAYINFO":{
"LANGUAGE":"ENG",
"LOGOFILENAME":"",
"VOICEFILENAME":""
}
},
"ITEMIZEDDISCLAIMERS":{
"DISCLAIMERTEXT":"Garnishment requests should be sent to: Vail Resorts, Inc. Attention Payroll 390 Interlocken Crescent Broomfield, CO 80021",
"DISCLAIMERTYPE":"ER"
}
}
}
]
},
"SPECIALHANDLING":{
"DEMOHANDLING":"DEMO"
}
}
},
"SIGNONMSGSRSV1":{
"SONRS":{
"STATUS":{
"CODE":0,
"SEVERITY":"INFO"
},
"DTSERVER":20220727134353,
"LANGUAGE":"ENG"
}
}
}
}
},
"created_at":"2022-07-15T21:12:43.017Z",
"updated_at":"2022-07-27T13:44:14.041Z"
}
```
### Console
You can also use Console to see each user's inputs (SSN, DOB) as well as a credit bureau's response converted from XML to JSON.
## Sandbox
To explore the solution in Sandbox you will need to use one of these 5 SSNs (any DOB value is permissible):
* 999001147
* 999009066
* 999478801
* 999601111
* 999606666
The Argyle API then responds with synthetic data, which follows the exact same structure as a credit bureau's production data. If any other SSN value is provided in the Sandbox, Argyle returns an error with an “Employee not found in database” message.
## Next steps
For more details, reach out to your respective Customer Success Manager, Account Executive, or [support@argyle.com](mailto:support@argyle.com).