Verify Bank Account

POST

https://api.sfox.com/v1/user/bank/verify

Verify micro-deposits sent to your bank account from sFOX.


For bank accounts linked manually (Create Bank Account), sFOX uses micro-deposits to to verify the account.

  • sFOX will deposit two <$1 amounts to the user's linked bank account. Micro-deposits expect to be be completed within 1-3 business days after linking the bank account. If the user has not received the deposits within 3 days, please contact [email protected]

  • Collect these amounts from your end user and use the request below to verify.

Until verification is completed the user's bank account will be in a "Pending Verification" status. Bank account status may be retrieved using a Get Bank Account request.

Request

Authentication: This endpoint requires a User Auth Token for authentication. Requests using your Connect API Key will be rejected.

Body Parameters

Name
Description

amount1 required, number

The value of the first micro-deposit. amount1 should be a number less than 1.

amount2 required, number

The value of the second micro-deposit. amount2 should be a number less than 1.

Example Requests

curl -X POST \
  -H 'Content-type: application/json' \
  -H "Authorization: Bearer ${USER_AUTH_TOKEN}" \
  --data '{ "amount1": ${AMOUNT_1}, "amount2": ${AMOUNT_2} }'  \
  'https://api.sfox.com/v1/user/bank/verify'

Response

Response Fields

Field
Description

success string

Whether verification succeeded. Possible values: true, false

Responses

200: OK

The following is an example response body to successfully verifying micro-deposits:

{
    "success": true
}
400: Bad Request
// Exceeded maximum verification attempts. 
// Re-link a bank account by deleting the current bank account and creating a new bank account.
{
    "error": "You have exceeded the maximum attempts to verify your bank account. Please add your bank account again to restart verification."
}

Last updated