Create an external account object.

External account statuses

In the Orum system, an external account can have one of the following statuses, indicated by the status field:

  • Created - An external account was created. The external account is not able to send or receive funds.
  • Verified - An external account passed verification. The external account is able to send or receive funds.
  • Rejected - An external account did not pass verification. The external account is not able to send or receive funds.
  • Restricted - An external account was matched against a sanctions watchlist. The external account is not able to send or receive funds.
  • Closed - An external account has been soft deleted from Orum’s platform. The closed external account is not able to send or receive funds.

Note: If you are using your own account verification provider (BYO-AVS), all external accounts you create will automatically have a Verified status, and the POST API response will return the external account with a status of “verified”.

Simulating external account statuses in sandbox

In sandbox, all external accounts you create will have a status of created in the POST response and will then move to a status of verified.

To simulate non-verified 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 created to the simulated status.

account_holder_nameResults in status of
"rejected account""rejected"
"restricted account""restricted"
"closed account""closed"

Note: You will have to configure webhooks in order to receive the expected status update events.

Language
Authentication
Bearer
Click Try It! to start a request and see the response here!