Overview

Introduction

Throughout the API and File Delivery interfaces, you will see areas where Lead expects a reference to a Document you have collected as part of program operation. In each of these cases, Lead expects that a document is delivered into the /documents SFTP directory; the references inform Lead of how to retrieve the underlying documents from our SFTP directory. This page outlines how to reference documents in each interface that expects document references.

Document Upload

SFTP

Documents that are referenced in Lead Interfaces should be uploaded via SFTP. To upload a document, upload a PDF, JPG, JPEG, PNG, or HTML file into the /documents directory of your SFTP Folder.

Document References

Entity API

Field	Type	Required	Instruction
`individual_details.identification_details.identification_documents[].client_document_id`	String	Optional - provided if a document upload rather than an approved eKYC workflow is used to support entity identification information.	Populate `client_document_id` with the filename of the file in the SFTP directory.
`individual_details.identification_details.additional_documents[].client_document_id`	String	Optional - provided if a document upload rather than an approved eKYC workflow is used to support entity identification information.	Populate `client_document_id` with the filename of the file in the SFTP directory.
`business_details.identification_details.identification_documents[].client_document_id`	String	Optional - provided if a document upload rather than an approved eKYC workflow is used to support entity identification information.	Populate `client_document_id` with the filename of the file in the SFTP directory.
`business_details.identification_details.additional_documents[].client_document_id`	String	Optional - provided if a document upload rather than an approved eKYC workflow is used to support entity identification information.	Populate `client_document_id` with the filename of the file in the SFTP directory.

Customers File

Field	Type	Required	Instruction
`identification_documents[].client_document_id`	String	Optional - provided if a document upload rather than an approved eKYC workflow is used to support entity identification information.	Populate `client_document_id` with the filename of the file in the SFTP directory.
`additional_documents[].client_document_id`	String	Optional - provided if a document upload rather than an approved eKYC workflow is used to support entity identification information.	Populate `client_document_id` with the filename of the file in the SFTP directory.

Applications File

Field	Type	Required	Instruction
`documents`	JSON List	Required	Each object in the JSON should conform to the Compliance Document Reference Schema. For `document_id`, populate the File Name of the underlying file stored in the SFTP directory.

Accounts File

Field	Type	Required	Instruction
`documents`	JSON List	Required	Each object in the JSON should conform to the Compliance Document Reference Schema. For `document_id`, populate the File Name of the underlying file stored in the SFTP directory.

Foundations

File Guides

Introduction

Document Upload

SFTP

Document References

Entity API

Customers File

Applications File

Accounts File

​Introduction

​Document Upload

​SFTP

​Document References

​Entity API

​Customers File

​Applications File

​Accounts File

Introduction

Document Upload

SFTP

Document References

Entity API

Customers File

Applications File

Accounts File