Account Status

In sandbox, all accounts that you attempt to verify will have a verification_status of "pending" in the POST response and will then move to a verification_status of "valid", unless you are simulating a non-valid status.

To simulate non-valid verification_statuses, pass the status you want to simulate in the account_holder_name field along with all other required fields. You will receive a webhook when the account's status updates from "pending" to the simulated status.

NOTE: Only "failed" and "invalid" non-valid verifications statuses are supported in sandbox.

Account Ownership

Orum verifies account ownership by pushing a four character code to the bank account statement of your end user. Once the user locates this code on the account statement, there are two ways in which we can confirm that the code Orum sent to a specific account is in fact the code that the user located on their statement. You can either send back the code via the Ownership endpoint (API-Based solution), or if you provide the end users email address, Orum can automatically send them an email with instructions to provide the code to us directly via a website that Orum hosts (Email-Based solution). Our sandbox environment supports both methods of Ownership verification, and whether or not you provide an email address in the optional "email" field will dictate the method for testing (i.e. if you provide an email address, an email will be triggered and if you don't, you can hit the Ownership endpoint once the code has been located).

Sandbox Environment for API-Based Ownership

To simulate a valid ownership response, pass "0000" in the statement_code field.

To simulate an invalid ownership response, pass any value other than "0000" in the statement_code field.

Sandbox Environment for Email-Based Ownership

When you test this end-to-end Ownership experience, we ask that you use a legitimate email address in the API request. The email address you provide will receive an email from [email protected] with instructions on next steps. Once you navigate to the Orum-hosted website, use "0000" to simulate a valid Ownership response and any other value to simulate an invalid Ownership response. You can then check the status of your Ownership Verification by enabling webhooks, using our GET endpoints, or by polling the API.

❗️

Important

You must be configured for the Account Ownership endpoint. Reach out to your Orum representative for more details if you plan to incorporate ownership verification into your product.