API Documentation

AccountChek Statuses

Verifier API Statuses

AccountChekOrder Status

Status Description
building The AccountChekOrder is being built. You are allowed at this point to add different services (ex. VOA and/or VOIE) to the order.
opened The AccountChekOrder is finished building and ready for the Borrower to take action.
inprogress The Borrower has started action against the AccountChekOrder.
closed The AccountChekOrder has been closed by the system and is considered completed.
canceled The AccountChekOrder was canceled either while still being built or before the Borrower had taken action.

VOA Status

Status Code Verifier Text Borrower Stage Borrower Stage - Details Next Steps
500 Not Opened Invite in Process - Customer has Not Accepted Terms of Service Invite email has been sent, but borrower has not logged into the system yet. Send a reminder to the borrower to check their email and spam folder OR “resend” the invite via the “retrieve orders” tab. AccountChek will send them automatic reminders once a day for 5 days.
501 Pending Arrived at Site Borrower access has been validated.  
5010 Not Opened SSO Link Expired Borrower tried to launch AccountChek using an SSO link that has expired. Notification sent back to Verifier’s platform. They will need to generate a new SSO Url for the Borrower to use.
503 Pending Financial Institution (Bank) Selected Borrower has successfully logged into AccountChek, but they have not started account enrollment. AccountChek will automatically send email reminders for them to finish their enrollment. Borrowers who do not know their online banking credentials will often not be able to proceed beyond this stage. Ask the Borrower go to their online banking website and request a new username and/or password if necessary.
505 Pending Enrollment Started The Borrower has entered the online banking credentials. AccountChek will automatically send email reminders for the Borrower finish their enrollment and notify you, the verifier, when a report is ready.
506 Pending Performing Multi-Factor Authentication The Borrower is going through the MFA flow as specified by their financial institution. AccountChek will automatically send email reminders for the Borrower finish their enrollment and notify you, the verifier, when a report is ready.
5061 Pending Starting Account Verification The Borrower is done enrolling their account. We are now validating information with the financial institution. AccountChek will notify you, the verifier, when a report is ready. You may also login into the online verifier portal and check status information there.
507 Complete Report Ready The VOA process has completed and an initial report has been generated. AccountChek has notified you, the verifier, that a report is ready. You may now login to the online verifier portal and download the report.
509 Needs Update Credential Update Needed from Customer During an attempt to retrieve updated information about the Borrower’s bank accounts AccountChek was unable to authenticate with one or more the Borrower’s financial institutions. The Borrower should be directed back to AccountChek to update their online banking credentials. AccountChek will automatically email the Borrower informing them that they need to re-enter their online banking credentials.
5101 Complete Report Queued The Borrower has completed account enrollment and the initial report is queued for generation. At this point, the account numbers and balances are available from the API endpoints.  
510 Complete Report in Process A new report is being generated AccountChek will send you, the verifier, an email when the newly generated report is ready. You may now login and download the report.
511 Alert Insufficient History An insufficient amount of history was retrieved from the Borrower’s financial institution. Please contact AccountChek customer support to attempt to resolve the issue.
512 Alert Enrolled - Harvest Unsuccessful An error occurred getting the Borrower’s data from the financial institution This is generally a transient error and directly asking the system to generate a new report can usually clear the error. If the error is persistent please contact AccountChek support for help.
513 Closed Refresh Period Ended The VOA refresh period has ended and the VOA is closed or canceled. At this point, it is no longer possible to get updated information for Borrower accounts or generate new reports. If you accidentally closed or canceled the VOA you will have to start a new VOA. No further action is needed.
5031 Alert Issue Validating Online Banking Credentials The online banking credentials provided by Borrower could not be validated. Borrowers who have forgotten their online banking credentials will often be stuck at this stage. Ask the Borrower to go to their online banking website to validate the username and password or request new credentials.
5032 Alert Unable to Connect to Financial Institution From AccountChek’s perspective is appears the Borrower’s banking website is down. If the banks website is not down and/or the error persists for more than a 24 hour period please contact AccountChek support.
5070 Complete SnapCheck Data Ready SnapChek data is ready to be downloaded.  
540 Data Unaccessible Data Integrity The data provided by the source financial institution did not pass the AccountChek Data Quality Checks. This can occur if the direct source data from the financial institution has duplicate or malformed information. The account enrollment should be tried at a later time, as this is usually a transient error.
700 Triaged Harvest Already in Progress This occurs when a Verifier initiated action would have caused the system to initiate two harvests against a Borrower’s accounts. This is a transient error that can be cleared by Verifier without help from AccountChek. This typically occurs with Verifier API integrations that have requested more than one report simultaneously and both attempt to harvest the Borrower’s accounts. The resolution is to wait for a single report to finish for a given VOA before attempting to generate another report. Any successful report generation will clear this status code.

VOA Report Status

Status Description
400 Report Object Created
507 Report Ready
509 Borrower Credentials Need Update
5101 Report Queued
510 Report in Progress
511 Insufficient Transaction History
512 Enrolled - Harvest Unsuccessful
540 Data Error
700 Harvest Already in Progress

VOE Status

Status Code Description
created The VOE has been created.
inprogress The borrower has started the VOE workflow.
closed The AccountChek order has been closed.

VOE Report Status

Status Description
created The VOE report object has been created.
inprogress The VOE report is undergoing the generation process.
complete The VOE report has been successfully generated.
completewitherrors The VOE report was generated, but encountered some errors. This can occur if an aggregation source provider encountered an MFA during a refresh.
failed An error was encountered when generating the VOE report.
credentialupdaterequired The employment provider requires the borrower to update their credentials before a report can be generated.
harvestfailure Encountered a situation in which the data from the provider is unavailable.

VOE Webhook Status

Status Description
601 The borrower arrived at the provider login.
607 The VOIE report has been generated.
609 Needs update - borrower credentials or MFA update required to reestablish connection.
610 Borrower credentials validated.
634 Provider login error.
Client Testing (CTE) Domains
  • https://verifierapi.accountchek.net
  • https://validatorapi.accountchek.net
Production Domains
  • https://verifierapi.accountchek.com
  • https://validatorapi.accountchek.com