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
| Name | Type | Description |
|---|---|---|
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"
],
"common_name": "Invoice",
"description": "Billing statement for goods or services provided between two parties ",
"multiple_allowed": false,
"required_meta": [],
"type": "INVOICE"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"PERSONAL"
],
"common_name": "Mortgage Statement",
"description": "Document issued by a mortgage holder to the borrower detailing the terms of the mortgage loan",
"multiple_allowed": false,
"required_meta": [],
"type": "MORTGAGE_STATEMENT"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"BUSINESS",
"PERSONAL"
],
"common_name": "Property Tax Receipt",
"description": "Receipt for the payment of annual property taxes",
"multiple_allowed": false,
"required_meta": [],
"type": "PROPERTY_TAX_RECEIPT"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"BUSINESS",
"PERSONAL"
],
"common_name": "Lease Agreement",
"description": "Property rental agreement between a landlord and a tenant",
"multiple_allowed": false,
"required_meta": [],
"type": "LEASE_AGREEMENT"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"PERSONAL"
],
"common_name": "University Lease",
"description": "Property rental agreement between a University and a student",
"multiple_allowed": false,
"required_meta": [],
"type": "UNIVERSITY_LEASE"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"BUSINESS",
"PERSONAL"
],
"common_name": "Utility Bill",
"description": "A billing statement issued by a company provided utility services, this may include water, gas, or telecom services",
"multiple_allowed": false,
"required_meta": [],
"type": "UTILITY_BILL"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"PERSONAL"
],
"common_name": "Form I-94",
"description": "Record of travel history for individuals to and from the US, who are not citizens or permanent residents",
"multiple_allowed": false,
"required_meta": [],
"type": "FORM_I94"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"PERSONAL"
],
"common_name": "Form I-20",
"description": "Certificate of eligibility for nonimmigrant student status issued by a certified school",
"multiple_allowed": false,
"required_meta": [],
"type": "FORM_I20"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"PERSONAL"
],
"common_name": "Form DS-2019",
"description": "Document that allows the bearer to apply for the J-1 Visa as an Intern or Trainee in the USA",
"multiple_allowed": false,
"required_meta": [],
"type": "FORM_DS2019"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"PERSONAL"
],
"common_name": "Form I-797A, I-797B, or I-797C",
"description": "Receipt letter issued by the United States Citizenship and Immigration Services once they have received an application ",
"multiple_allowed": false,
"required_meta": [],
"type": "FORM_I797"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"PERSONAL"
],
"common_name": "EAD Card",
"description": "Employment Authorization Card for immigrants to a certain country",
"multiple_allowed": false,
"required_meta": [
"country_code",
"id_number"
],
"type": "EMPLOYMENT_AUTHORIZATION_CARD"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"PERSONAL"
],
"common_name": "Permanent Resident Card",
"description": "Issued to immigrants as evidence that the individual has been approved to reside in a given country permanently",
"multiple_allowed": false,
"required_meta": [
"country_code",
"id_number"
],
"type": "PERMANENT_RESIDENT_CARD"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"PERSONAL"
],
"common_name": "Back of Permanent Resident Card",
"description": "Back of card issued to immigrants as evidence that the individual has been approved to reside in a given country permanently",
"multiple_allowed": false,
"required_meta": [
"country_code",
"id_number"
],
"type": "PERMANENT_RESIDENT_CARD_BACK"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"PERSONAL"
],
"common_name": "National Identification Card",
"description": "Photo ID issued by the relevant national authority",
"multiple_allowed": false,
"required_meta": [
"country_code",
"id_number"
],
"type": "NATIONAL_ID"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"PERSONAL"
],
"common_name": "Back of National Identification Card",
"description": "Back of Photo ID issued by the relevant national authority",
"multiple_allowed": false,
"required_meta": [
"country_code",
"id_number"
],
"type": "NATIONAL_ID_BACK"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"PERSONAL"
],
"common_name": "Passport Card",
"description": "Photo ID and limited travel card issued by the relevant government authority",
"multiple_allowed": false,
"required_meta": [
"country_code",
"id_number"
],
"type": "PASSPORT_CARD"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"PERSONAL"
],
"common_name": "Driver's License",
"description": "Photo ID and authorization to operate a vehicle issued by the relevant government authority ",
"multiple_allowed": false,
"required_meta": [
"country_code",
"id_number"
],
"type": "DRIVER_LICENSE"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"PERSONAL"
],
"common_name": "Back of Driver's License",
"description": "Back of Photo ID and authorization to operate a vehicle issued by the relevant government authority ",
"multiple_allowed": false,
"required_meta": [
"country_code",
"id_number"
],
"type": "DRIVER_LICENSE_BACK"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"PERSONAL"
],
"common_name": "Voter Registration Card",
"description": "Document confirming an individual is registered to vote in elections issued by the relevant government authority",
"multiple_allowed": false,
"required_meta": [
"country_code",
"id_number"
],
"type": "VOTER_REGISTRATION_CARD"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"PERSONAL"
],
"common_name": "Back of Voter Registration Card",
"description": "Back of document confirming an individual is registered to vote in elections issued by the relevant government authority",
"multiple_allowed": false,
"required_meta": [
"country_code",
"id_number"
],
"type": "VOTER_REGISTRATION_CARD_BACK"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"BUSINESS"
],
"common_name": "Legal Opinion Letter",
"description": "Image/PDF of Legal Opinion Letter",
"multiple_allowed": false,
"required_meta": [],
"type": "LEGAL_OPINION_LETTER"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"BUSINESS"
],
"common_name": "No Action Letter",
"description": "Image/PDF of No Action Letter",
"multiple_allowed": false,
"required_meta": [],
"type": "NO_ACTION_LETTER"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"BUSINESS"
],
"common_name": "Customers By Revenue",
"description": "List of top four customers by revenue",
"multiple_allowed": false,
"required_meta": [],
"type": "CUSTOMERS_BY_REVENUE"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"BUSINESS"
],
"common_name": "Fraud Program",
"description": "Image/PDF of Fraud Program",
"multiple_allowed": false,
"required_meta": [],
"type": "FRAUD_PROGRAM"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"BUSINESS"
],
"common_name": "Complaints Support Audit",
"description": "Third Party independent audit of complaints and end user support process",
"multiple_allowed": false,
"required_meta": [],
"type": "COMPLAINTS_SUPPORT_AUDIT"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"BUSINESS"
],
"common_name": "Wolfsberg Questionnaire",
"description": "Correspondent Banking Due Diligence Questionnaire",
"multiple_allowed": false,
"required_meta": [],
"type": "WOLFSBERG_QUESTIONNAIRE"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"BUSINESS"
],
"common_name": "Section 313 Foreign Bank Certificate",
"description": "Certification completed by a foreign bank",
"multiple_allowed": false,
"required_meta": [],
"type": "SECTION_313_FOREIGN_BANK_CERTIFICATE"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"BUSINESS"
],
"common_name": "Cyber Liability Insurance",
"description": "Image/PDF of Cyber Liability Insurance",
"multiple_allowed": false,
"required_meta": [],
"type": "CYBER_LIABILITY_INSURANCE"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"PERSONAL"
],
"common_name": "VCheck Content Form",
"description": "International authorization form",
"multiple_allowed": false,
"required_meta": [],
"type": "VCHECK_CONTENT_FORM"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"PERSONAL"
],
"common_name": "Resume",
"description": "Image/PDF of resume",
"multiple_allowed": false,
"required_meta": [],
"type": "RESUME"
},
{
"allowed_file_types": [
"png",
"jpg",
"jpeg",
"pdf"
],
"base_doc_types": [
"BUSINESS"
],
"common_name": "501(C)(3) Notification",
"description": "The official letter notifying that your organization is entitled to the federal tax exemption as a 501(c)(3) charity.",
"multiple_allowed": false,
"required_meta": [],
"type": "501_C_3_NOTIF"
}
],
"social_docs": [
{
"base_doc_types": [
"PERSONAL"
],
"common_name": "Facebook",
"description": "Using Sign in with Facebook to verify identity",
"multiple_allowed": false,
"required_meta": [],
"type": "FACEBOOK"
},
{
"base_doc_types": [
"PERSONAL"
],
"common_name": "LinkedIn",
"description": "Using Sign in with LinkedIn to verify identity",
"multiple_allowed": false,
"required_meta": [],
"type": "LINKEDIN"
},
{
"base_doc_types": [
"PERSONAL"
],
"common_name": "Twitter",
"description": "Using Sign in with Twitter to verify identity",
"multiple_allowed": false,
"required_meta": [],
"type": "TWITTER"
},
{
"base_doc_types": [
"PERSONAL",
"BUSINESS"
],
"common_name": "Website",
"description": "Website to verify identity",
"multiple_allowed": false,
"required_meta": [],
"type": "WEBSITE"
},
{
"base_doc_types": [
"PERSONAL",
"BUSINESS"
],
"common_name": "Email via 2FA",
"description": "Using two-factor authentication to verify email",
"multiple_allowed": false,
"required_meta": [],
"type": "EMAIL_2FA"
},
{
"base_doc_types": [
"PERSONAL",
"BUSINESS"
],
"common_name": "Phone Number via 2FA",
"description": "Using two-factor authentication to verify phone number",
"multiple_allowed": false,
"required_meta": [],
"type": "PHONE_NUMBER_2FA"
},
{
"base_doc_types": [
"PERSONAL"
],
"common_name": "Employer's name",
"description": "Name of Employer",
"multiple_allowed": false,
"required_meta": [],
"type": "EMPLOYER"
},
{
"base_doc_types": [
"PERSONAL"
],
"common_name": "University's name ",
"description": "Name of University",
"multiple_allowed": false,
"required_meta": [],
"type": "UNIVERSITY"
},
{
"base_doc_types": [
"PERSONAL",
"BUSINESS"
],
"common_name": "Other Social Media",
"description": "Using other social media to verify identity",
"multiple_allowed": true,
"required_meta": [],
"type": "OTHER"
},
{
"base_doc_types": [
"PERSONAL",
"BUSINESS"
],
"common_name": "Mailing Address",
"description": "Using mailing address for shipping cards, checks and account closure",
"multiple_allowed": true,
"required_meta": [
"address_street",
"address_city",
"address_subdivision",
"address_country_code",
"address_postal_code"
],
"type": "MAILING_ADDRESS"
}
],
"virtual_docs": [
{
"base_doc_types": [
"PERSONAL"
],
"common_name": "Social Security Number",
"description": "Social Security Number issued by the Social Security Administration",
"multiple_allowed": false,
"required_meta": [],
"type": "SSN"
},
{
"base_doc_types": [
"PERSONAL"
],
"common_name": "Passport Number",
"description": "Passport Number issued by the Country of Origin",
"multiple_allowed": false,
"required_meta": [],
"type": "PASSPORT"
},
{
"base_doc_types": [
"PERSONAL"
],
"common_name": "Driver's License Number",
"description": "Driver's License Number issued by the DMV",
"multiple_allowed": false,
"required_meta": [],
"type": "DRIVERS_LICENSE"
},
{
"base_doc_types": [
"PERSONAL"
],
"common_name": "Personal Identification Number",
"description": "Personal Identification Number issued by the Country of Origin",
"multiple_allowed": false,
"required_meta": [],
"type": "PERSONAL_IDENTIFICATION"
},
{
"base_doc_types": [
"BUSINESS",
"PERSONAL"
],
"common_name": "Tax Identification Number",
"description": "Tax Idenfitication Number issued by the relevant government authority (i.e., SSN in the US, CPF in Brazil, etc.)",
"multiple_allowed": false,
"required_meta": [
"country_code"
],
"type": "TIN"
},
{
"base_doc_types": [
"BUSINESS"
],
"common_name": "Business Registration",
"description": "A secondary Tax Idenfitication Number issued by the relevant government authority (i.e., TIN in the US, CNPJ in Brazil, etc.)",
"multiple_allowed": false,
"required_meta": [
"sub_type"
],
"type": "BUS_REGISTRATION"
},
{
"base_doc_types": [
"BUSINESS"
],
"common_name": "Data Universal Numbering System (DUNS) Number",
"description": "DUNS number assined to the company by Dun & Bradstreet",
"multiple_allowed": false,
"required_meta": [],
"type": "DUNS"
},
{
"base_doc_types": [
"PERSONAL"
],
"common_name": "Country of Citizenship",
"description": "The user's country of citizenship",
"multiple_allowed": false,
"required_meta": [],
"type": "CITIZENSHIP"
},
{
"base_doc_types": [
"PERSONAL"
],
"common_name": "State Identification Foreign",
"description": "Foreign state level identification",
"multiple_allowed": false,
"required_meta": [],
"type": "STATE_IDENTIFICATION_FOREIGN"
},
{
"base_doc_types": [
"PERSONAL"
],
"common_name": "Father Full Name",
"description": "Document showing father's full name",
"multiple_allowed": false,
"required_meta": [],
"type": "FATHER_FULL_NAME"
},
{
"base_doc_types": [
"PERSONAL"
],
"common_name": "Mother Full Name",
"description": "Document showing mother's full name",
"multiple_allowed": false,
"required_meta": [],
"type": "MOTHER_FULL_NAME"
},
{
"base_doc_types": [
"PERSONAL",
"BUSINESS"
],
"common_name": "DTI",
"description": "Debt-to-Income Ratio",
"multiple_allowed": false,
"required_meta": [],
"type": "DTI"
},
{
"base_doc_types": [
"PERSONAL"
],
"common_name": "Nationality",
"description": "Country of origin",
"multiple_allowed": false,
"required_meta": [],
"type": "NATIONALITY"
},
{
"base_doc_types": [
"PERSONAL",
"BUSINESS"
],
"common_name": "Other Virtual Documents",
"description": "Using other document to verify an individual or business",
"multiple_allowed": true,
"required_meta": [],
"type": "OTHER"
}
]
}Example Request
GET /v3.1/users/document-types HTTP/1.1
Host: uat-api.synapsefi.comcurl --location --request GET 'https://uat-api.synapsefi.com/v3.1/users/document-types'////////Last updated