Submit Documents API
Submit a document or set of documents on behalf of an end user. An end user may be of account type individual or corporate.
POST
https://api.sfox.com/v1/files/verification
Overview
This API allows Connect partners to submit one or more documents on behalf of an individual or corporate account.
The following steps provide an overview of how to do so:
First, you must obtain a User Auth Token, as that is going to be used during authorization when calling POST
/files/verification. You can obtain a User Auth Token using this endpoint.Then, you must obtain the sFOX-provided
idthat corresponds to the end user for which you are submitting documents. You can obtain the properidby calling the GETuser/{user_id}endpoint.
You now have the necessary information to call the
/files/verificationendpoint to submit documents. A few notes:The request should use
form-dataencoding.There are two
field namesthat must exist as part of the request:dataandfiles.The
datafield includes the JSON encoded payload as defined below.The
filesfield is an array of files that are binary encoded.
Regarding document context
A document is of a certain type, such as a passport or ownership_chart. Additionally a document is submitted to sFOX for a purpose; that purpose is to fulfill one or more requirements.
This structure allows the sFOX team to obtain contextual information about the documents submitted and review them with that knowledge in-hand.
Request Fields
The data field includes a JSON payload with the below attributes:
filename required
string
The name of the file being uploaded, including the extension. This must match the name of the file in the files key.
Example: funding-overview.png
document_type required
string
Must be one of the following: passport, drivers_license_front, drivers_license_back, state_provincial_id_front, state_provincial_id_back, national_id_front, national_id_back, military_id, matriculate_id, visa, bank_statement, utility_bill, payslip, business_formation, ownership_chart, ownership_information, flow_of_funds, directors_register, aml_policy, shareholder_register, evidence_of_good_standing, marketing_materials, tax_id, e_signature_agreement, balance_sheet, financials, taxes, other
requirements required
array
Must be one or more of the following, separated by a comma: identity_verification, proof_of_address, proof_of_source_of_funds, proof_of_financial_means, proof_of_tax_id, proof_of_relationship, proof_of_nature_of_business, proof_of_account_purpose, proof_of_authority, proof_of_name_change, business_formation, business_ownership_or_organization_structure, other
related_entity_id
required
string
The id corresponding to the individual or beneficial owner (for corporate accounts) for which you are submitting documents.
Example Requests
Document Requirements
The supported MIME types for document submission are
image/jpeg,image/png,application/pdf.File extension must be one of
jpg,jpeg,png,pdf.The file names specified for each file in the
filesarray must exactly match the file name included in thedataJSON payload.
Response
Last updated