Allowed Document Types

Document Types

GET https://api.synapsefi.com/v3.1/users/document-types

This endpoint allows you to get and view all the avaliable document types.

Headers

NameTypeDescription

X-SP-USER

string

Your OAuth key and device fingerprint, separated by a pipe.

X-SP-USER-IP

string

IP address of your device.

X-SP-GATEWAY

string

Your Client ID and Secret, separated by a pipe.

{
    "physical_docs": [
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg"
            ],
            "base_doc_types": [
                "PERSONAL"
            ],
            "common_name": "Photo ID",
            "description": "A government issued photo ID (driver's license, state ID, or passport)",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "GOVT_ID"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg"
            ],
            "base_doc_types": [
                "PERSONAL"
            ],
            "common_name": "International Photo ID",
            "description": "A government issued photo ID (driver's license, state ID, or passport) that is not in English",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "GOVT_ID_INT"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg"
            ],
            "base_doc_types": [
                "PERSONAL"
            ],
            "common_name": "Back of Photo ID",
            "description": "Back of a government issued photo ID (driver's license, state ID, or passport)",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "GOVT_ID_BACK"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg"
            ],
            "base_doc_types": [
                "PERSONAL"
            ],
            "common_name": "Back of International Photo ID",
            "description": "Back of a government issued photo ID (driver's license, state ID, or passport) that is not in English",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "GOVT_ID_INT_BACK"
        },
        {
            "allowed_file_types": [
                "mov",
                "mp4",
                "webm",
                "avi",
                "flv",
                "mkv",
                "ogg"
            ],
            "base_doc_types": [
                "PERSONAL"
            ],
            "common_name": "Video Authorization",
            "description": "A 5 second video authorizing this account",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "VIDEO_AUTHORIZATION"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg"
            ],
            "base_doc_types": [
                "PERSONAL"
            ],
            "common_name": "Selfie",
            "description": "",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "SELFIE"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "PERSONAL",
                "BUSINESS"
            ],
            "common_name": "Proof of address",
            "description": "Proof of residence at current address (utility bill or bank account statement)",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "PROOF_OF_ADDRESS"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "PERSONAL",
                "BUSINESS"
            ],
            "common_name": "Proof of income",
            "description": "Proof of annual income (pay stub or tax returns)",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "PROOF_OF_INCOME"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "PERSONAL",
                "BUSINESS"
            ],
            "common_name": "Proof of account",
            "description": "Proof of account ownership (bank account statement)",
            "multiple_allowed": true,
            "required_meta": [],
            "type": "PROOF_OF_ACCOUNT"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "PERSONAL",
                "BUSINESS"
            ],
            "common_name": "Authorization",
            "description": "A signed ACH authorization",
            "multiple_allowed": true,
            "required_meta": [],
            "type": "AUTHORIZATION"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg"
            ],
            "base_doc_types": [
                "PERSONAL"
            ],
            "common_name": "Social Security Card",
            "description": "Image of social security card issued by the Social Security Administration",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "SSN_CARD"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "Employer Identification Number Document",
            "description": "Image of Form 147C issued to the business by the IRS",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "EIN_DOC"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "Employer Identification Number Application",
            "description": "Image of Form SS4 that is used by a business to apply for a TIN number",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "SS4_DOC"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "PERSONAL",
                "BUSINESS"
            ],
            "common_name": "W-9 Document",
            "description": "Image of W-9 document issued by the IRS (with EIN visible)",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "W9_DOC"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "PERSONAL"
            ],
            "common_name": "W-8 Document",
            "description": "Image of W-8 document issued by the IRS (with SSN/TIN visible)",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "W8_DOC"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS",
                "PERSONAL"
            ],
            "common_name": "W-2 Document",
            "description": "Image of W-2 document issued by the Employer (with SSN/TIN visible)",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "W2_DOC"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg"
            ],
            "base_doc_types": [
                "PERSONAL",
                "BUSINESS"
            ],
            "common_name": "Voided Check",
            "description": "Image of a voided check from the bank (with account number and name on account visible)",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "VOIDED_CHECK"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "Articles of Incorporation",
            "description": "Image/PDF of company's Articles of Incorporation (with name and address of company visible)",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "AOI"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "Company Bylaws",
            "description": "Image/PDF of company's Bylaws (with name, address of company and key shareholder information visible)",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "BYLAWS_DOC"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "Letter of Engagement",
            "description": "Image/PDF of Letter of Engagement (with name and address visible)",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "LOE"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "Certificate of Incumbency",
            "description": "Image/PDF of Certificate of Incumbency",
            "multiple_allowed": true,
            "required_meta": [],
            "type": "COI"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "Local Business Licenses",
            "description": "Image/PDF of Local Business Licenses",
            "multiple_allowed": true,
            "required_meta": [],
            "type": "LBL"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "US Subsidiary or Domestic Presence on Business Documents",
            "description": "Image/PDF of US Subsidiary or Domestic Presence on Business Documents",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "SUBSIDIARY_DOC"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "AML Policies",
            "description": "Image/PDF of AML Policies",
            "multiple_allowed": true,
            "required_meta": [],
            "type": "AML_POLICY"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "Detailed Business Plan",
            "description": "Image/PDF of Detailed Business Plan",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "BUSINESS_PLAN"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "Money Transmission Licenses",
            "description": "Image or PDF of Money Transmission Licenses",
            "multiple_allowed": true,
            "required_meta": [
                "state_code"
            ],
            "type": "MTL"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "MSB / FINCEN Registration",
            "description": "Image/PDF of MSB / FINCEN Registration",
            "multiple_allowed": true,
            "required_meta": [],
            "type": "MSB"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "Security Audit",
            "description": "Image/PDF of Security Audit",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "SECURITY_AUDIT"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "BSA Audit",
            "description": "Image/PDF of BSA Audit",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "BSA_AUDIT"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "SOC Audit",
            "description": "Image/PDF of SOC Audit",
            "multiple_allowed": true,
            "required_meta": [],
            "type": "SOC_AUDIT"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "State Audit",
            "description": "Image/PDF of State Audit",
            "multiple_allowed": true,
            "required_meta": [],
            "type": "STATE_AUDIT"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "Certificate of Business Insurance",
            "description": "Image/PDF of Certificate of Business Insurance",
            "multiple_allowed": true,
            "required_meta": [],
            "type": "BUSINESS_INSURANCE"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "Sample Customer Contract + Summary of Fees",
            "description": "Image/PDF of Sample Customer Contract + Summary of Fees",
            "multiple_allowed": true,
            "required_meta": [],
            "type": "TOS"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "KYC Policy",
            "description": "Image/PDF of KYC Policy",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "KYC_POLICY"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "CIP Document",
            "description": "Image/PDF of CIP Document",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "CIP_DOC"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "PERSONAL",
                "BUSINESS"
            ],
            "common_name": "Subscription Agreement",
            "description": "Image/PDF of Subscription Agreement",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "SUBSCRIPTION_AGREEMENT"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "PERSONAL",
                "BUSINESS"
            ],
            "common_name": "Promissory Note",
            "description": "Image/PDF of Promissory Note",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "PROMISSORY_NOTE"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "PERSONAL",
                "BUSINESS"
            ],
            "common_name": "Legal Agreement",
            "description": "Image/PDF of Legal Agreement",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "LEGAL_AGREEMENT"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "Reg GG Form",
            "description": "Image/PDF of Reg GG Form",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "REG_GG"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS",
                "PERSONAL"
            ],
            "common_name": "Deposit Agreement",
            "description": "E-Signed version of the deposit agreement",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "DEPOSIT_AGREEMENT"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "DBA Document",
            "description": "Image/PDF of DBA Document",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "DBA_DOC"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "PERSONAL",
                "BUSINESS"
            ],
            "common_name": "Other",
            "description": "Other document upload",
            "multiple_allowed": true,
            "required_meta": [],
            "type": "OTHER"
        },
        {
            "allowed_file_types": [
                "pdf"
            ],
            "base_doc_types": [
                "PERSONAL",
                "BUSINESS"
            ],
            "common_name": "Background Check",
            "description": "Background Check document upload",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "BG_CHECK"
        },
        {
            "allowed_file_types": [
                "pdf"
            ],
            "base_doc_types": [
                "PERSONAL",
                "BUSINESS"
            ],
            "common_name": "Background Check Consent",
            "description": "Background Check Consent document upload",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "BG_CHECK_CONSENT"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "Articles of Organization",
            "description": "A document filed with a government body that establishes the existence of a limited liability company",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "ARTICLES_ORGANIZATION"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "Memorandum of Incorporation",
            "description": "A document that details the rights, duties and responsibilities of shareholders, directors and other persons involved in a company. Very similar to Articles of Incorporation in the US",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "MEMO_OF_INCORPORATION"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "PERSONAL"
            ],
            "common_name": "Passport Bio Data page",
            "description": "Biodata page of the User's passport, which includes photo, name, date of birth, passport number, expiration date, etc. ",
            "multiple_allowed": false,
            "required_meta": [
                "country_code",
                "id_number"
            ],
            "type": "PASSPORT_BIODATA"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "PERSONAL"
            ],
            "common_name": "Passport Information page",
            "description": "Information page of passport, such as the page with the passport holder’s address (e.g., Indian passports)",
            "multiple_allowed": false,
            "required_meta": [
                "country_code",
                "id_number"
            ],
            "type": "PASSPORT_INFO"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "PERSONAL"
            ],
            "common_name": "VISA",
            "description": "Relevant visa in User's passport",
            "multiple_allowed": false,
            "required_meta": [
                "country_code",
                "id_number"
            ],
            "type": "VISA"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "Business License (city or county)",
            "description": "Business license, issued at the city or county level for the physical location of the business",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "BUSINESS_LICENSE"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "Foreign Entity Registration",
            "description": "Foreign entity registration for a company doing business in a state which is not the state in which they are primarily registered. This document is an acceptable alternative to a business license in jurisdictions where a business license is not required for all business types (e.g., New York)",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "FOREIGN_ENTITY_REGISTRATION"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS",
                "PERSONAL"
            ],
            "common_name": "Proof of source of funds",
            "description": "Document showing the source of funds for a specific transaction. This may include paystubs, investment distributions, etc. ",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "POSOF"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS"
            ],
            "common_name": "Profit and Loss Statement",
            "description": "A company's financial statement detailing revenue and expenses for a given period of time",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "PROFIT_LOSS"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS",
                "PERSONAL"
            ],
            "common_name": "Bank Statement ",
            "description": "Periodic statement issued by a financial institution detailing activity through an account held at the FI",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "BANK_STATEMENT"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "PERSONAL"
            ],
            "common_name": "1099-MISC",
            "description": "Income statement issued by clients for an independent contractor",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "1099-MISC"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "PERSONAL"
            ],
            "common_name": "Paystub",
            "description": "Document issued to indicate payroll details for a given payroll period",
            "multiple_allowed": false,
            "required_meta": [],
            "type": "PAYSTUB"
        },
        {
            "allowed_file_types": [
                "png",
                "jpg",
                "jpeg",
                "pdf"
            ],
            "base_doc_types": [
                "BUSINESS",
                "PERSONAL"