Skip to main content

Documentation

Upload Bank Statement Verification File

Upload a bank statement verification file in order to begin the process of adding a settlement bank account. After this method is completed successfully, you can proceed to add a settlement bank account.

Wait for the response for an upload request before initiating the next upload request. Do not execute multiple threads concurrently.

    • file parameter name

    • Use the --form parameter to define the path to the document file on your local machine. Enter the name of the file parameter followed by its path. For example, for the company_documents parameter where the file is located at C:/path/to/file/bank_statement.png, enter:

      --form 'company_documents=@"C:/path/to/file/bank_statement.png"' 

      Supported file types include '*.pdf', '.*csv', '*.jpeg', '*.jpg', '*.png'. Format of input must follow the multipart/form-data protocol. Use the files parameter to upload multiple files.

      Note

      • * Maximum size of files that can be uploaded in one request is 20 MB.

      • * Document file name should be up to 200 characters long.

Note

Uploading multiple files can return a Pending Review status for the files that were uploaded successfully and a Not Valid status for the file that was not uploaded due to an error such as an invalid file name.

The following parameters are returned for each uploaded file:

    • error

    • The error that occurred during the upload. Value is null when upload is successful.

    • field

    • The field name in the section of the application that the image is linked to.

    • file_name

    • The name of the uploaded file.

    • token

    • The identifier of the uploaded file. String starting with batch_.

    • upload_status

    • Status of the uploaded document. Values include Pending Review, Not Valid, Accepted, and Rejected.

  • /v1/partner/onboarding/organization/documents/bank_accounts

  • Upload Bank Statement Verification File

  • curl -X post 'https://api.rapyd.net/v1/partner/onboarding/organization/documents/bank_accounts
    -H 'access_key: your-access-key-here' \
    -H 'Content-Type: multipart/form-data' \
    -H 'idempotency: your-idempotency-parameter-here' \
    -H 'salt: your-random-string-here' \
    -H 'signature: your-calculated-signature-here' \
    -H 'timestamp: your-unix-timestamp-here' \
    -H 'merchant_account_id: your-merchant-account-here' \
    --form 'company_documents=@"/Users/John/Documents/2.png"' \
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "0bf00a37-d4a8-47ff-a7da-4ee70db57bbb"
        },
        "data": {
            "file_name": "2.png",
            "upload_status": "Pending review",
            "token": "batch_e34r5tg6hy7j8",
            "error": null,
            "field": "onboarding_bank_statement"
        }
    }