Skip to main content

​
Compliance Document Reference Schema

KeyData TypeRequirementExampleGuidance
document_id StringRequiredclient_document_name.pngPlease use the file name of the Document delivered to Lead’s /documents SFTP directory.
typeEnumRequiredpartner_privacy_policyPlease map all documents to one of the types below
displayed_atdatetimeConditionally Required2025-10-15T09:30:00ZPlease refer to the Compliance Document Types list to determine if this is required for the provided document type.
consented_atdatetime

ISO8601		Conditionally Required2025-10-15T09:30:00ZPlease refer to the Compliance Document Types list to determine if this is required for the provided document type.
versionstringOptional"v1"It is recommended to use this for static documents uploaded once and uploaded for many users. Uploads with a new version should have a different document_id as well.

​
Compliance Document Types

TypeDescriptionRequired Fields
aanAdverse Action Notice generated and sent/displayed to customer.displayed_at
loan_agreementLoan agreement displayed to customer.displayed_at
loc_agreementLine of Credit agreement displayed to customer.displayed_at
truth_in_lending_documentTruth in Lending disclosure displayed to customer.displayed_at
ach_authorizationACH Payment Authorization displayed to customer.displayed_at
notice_of_incompletenessNotice of Incompleteness displayed to customer.displayed_at
credit_score_noticeCredit score notice displayed to customer.displayed_at
offer_summaryOffer Summary displayed to customer.displayed_at
personal_guaranteePersonal Guaranty displayed to customer.displayed_at
consumer_credit_authCredit pull authorization obtained from customer.displayed_at
partner_privacy_policyPartner’s Privacy Policy displayed to customer.displayed_at
lead_privacy_policyLead’s Privacy Policy displayed to customer.displayed_at
terms_of_usePartner’s Terms of Use displayed to customer.displayed_at
esign_agreementeSign Agreement consented to by customer.consented_at
credit_pull_consentCredit pull authorization obtained from customer.consented_at
fcra_noticeFCRA Notice displayed to customer.displayed_at
tcpa_consentTCPA consent displayed to customer.displayed_at
patriot_act_noticePatriot Act notice displayed to customer.displayed_at
mla_noticeMilitary Lending Act notice displayed to customer.displayed_at
pre_approval_termsPre-Approval Terms displayed to customer.displayed_at
eft_authorizationEFT Authorization displayed to customer.displayed_at
prohibited_industry_certificationProhibited industry certification displayed to customer.displayed_at
decision_maker_documentDecision maker document displayed to customer.displayed_at
bo_certificationBusiness Owner Certification displayed to customer.displayed_at
missed_payments_policyMissed Payments Policy displayed to customer.displayed_at
consent_to_link_accountAccount link consent obtained from customer.consented_at
consent_to_link_hsaHSA link consent obtained from customer.consented_at
negative_option_consentNegative Option Consent obtained from customer.consented_at
lead_funds_transfer_agreementFunds transfer agreement displayed to customer.displayed_at