Skip to content

Upload a loan document

POST
/api/loan/document
partnerId
required
string format: uuid
sellerLoanId
required
string
documentName
string
tags
Array<string>
whatIf
boolean
object
document
required
string format: binary

OK

object
loans

Resulting loans snapshots, if any

Array
nullable
One of:
object
kind
required
string
id

The unique identifier of the loan

string
sellerPartnerId

The selling partner’s ID

string format: uuid
sellerPartnerName

The selling partner’s NAME

string
nullable
sellerLoanId

The selling partner’s internal loan id

string
dateListed

The date this loan was listed on the exchange

string format: date-time
nullable
dateInDefault

The date this loan went into default (if it did)

string format: date-time
nullable
dateSold

The date this loan was sold to a buyer

string format: date-time
nullable
dateLastPaid

The date the most recent payment was received

string format: date-time
nullable
datePaidInFull

The date this loan was paid in full

string format: date-time
nullable
dateWrittenOff

The date this loan was paid in full

string format: date-time
nullable
dateFunded

The date this loan was funded by the lender to the borrower

string format: date-time
nullable
dateReviewStarted

The date review started on this loan

string format: date-time
nullable
dateBuyerPreApproved

The date the buyer pre-approved this loan

string format: date-time
nullable
dateCreated

The date this record was initially created

string format: date-time
dateLastEvent

The date this record was last modified

string format: date-time
status
string
Allowed values: InServicing InDefault Terminal
terminalStatus
string
Allowed values: WrittenOff PaidOff
isForSale

Is the loan currently for-sale or not

boolean
sale
object
saleId

The unique id of the sale

string format: uuid
buyerPartnerId

The buyer partner id

string format: uuid
buyerPartnerName

The buyer partner’s NAME

string
nullable
status
string
Allowed values: Unlisted Listed InReview InReviewBuyerPreApproved InReviewSellerRequested BuyerCommitted SellerCommitted Sold SaleCancelled ReviewRejected
percent

Percent of loan for sale

number format: double
nullable
multiplier

Applies a percentage-based premium or discount as a multiplier

number format: double
nullable
serviceFee
One of:

Service fee agreed on during sale

object
type
required
string
Allowed values: PercentWithFloor Flat
percentAnnual
number format: double
floorFeeMonthly
number format: double
dateLastUpdated

Date the pending/sale was last updated

string format: date-time
nullable
dateRecommendedSaleClosed

Buyer Recommended Sale Close Date

string format: date-time
nullable
listingMetadata
object
loanAmount

The original amount of the loan

number format: double
nullable
percent

Percent of loan for sale

number format: double
nullable
multiplier

Applies a percentage-based premium or discount as a multiplier

number format: double
nullable
dateFunded

Date the loan was funded (close date / origination date)

string format: date-time
nullable
listingTag

The listing tag associated with this loan

string
nullable
interestRate
number format: double
nullable
termMonths
integer format: int32
nullable
interestOnlyPaymentAmount
number format: double
nullable
principalAndInterestPaymentAmount
number format: double
nullable
dateFirstPayment
string format: date-time
nullable
datePaymentTypeConversion
string format: date-time
nullable
isRefinance
boolean
nullable
serviceFee
One of:

If there are any service fees associated with this loan

object
type
required
string
Allowed values: PercentWithFloor Flat
percentAnnual
number format: double
floorFeeMonthly
number format: double
businessType
string
Allowed values: SoleProprietorship LLC Corporation NonProfit Partnership EmployeeOwned Other
businessAddressState
string
nullable
businessAddressCity
string
nullable
businessEmployeeCount
number format: double
nullable
businessIndustry
string
nullable
key
additional properties
privateMetadata
object
c2CLeadId

The associated Connect2Capital lead id

string format: uuid
nullable
businessName

Name of the business

string
nullable
businessAddress
object
line1
string
nullable
line2
string
nullable
city
string
nullable
state
string
nullable
postalCode
string
nullable
key
additional properties
buyerMetadata
object
tags

Buyer tags

Array<string>
nullable unique items
key
additional properties
loanDocuments

Loan’s documents

Array<object>
nullable
object
documentName

Name of the document

string
documentId

Document’s unique identifier

string format: uuid
tags

Document’s tags

Array<string>
nullable
dateUploaded

Date the document was uploaded

string format: date-time
nullable
errors
required

Resulting loan event issues, if any TODO: Create API model for this

Array<object>
object
message
string
index
integer format: int32
field
string
nullable
kind
string
Allowed values: None Warning Error IngestError

Bad Request

object
loans

Resulting loans snapshots, if any

Array
nullable
One of:
object
kind
required
string
id

The unique identifier of the loan

string
sellerPartnerId

The selling partner’s ID

string format: uuid
sellerPartnerName

The selling partner’s NAME

string
nullable
sellerLoanId

The selling partner’s internal loan id

string
dateListed

The date this loan was listed on the exchange

string format: date-time
nullable
dateInDefault

The date this loan went into default (if it did)

string format: date-time
nullable
dateSold

The date this loan was sold to a buyer

string format: date-time
nullable
dateLastPaid

The date the most recent payment was received

string format: date-time
nullable
datePaidInFull

The date this loan was paid in full

string format: date-time
nullable
dateWrittenOff

The date this loan was paid in full

string format: date-time
nullable
dateFunded

The date this loan was funded by the lender to the borrower

string format: date-time
nullable
dateReviewStarted

The date review started on this loan

string format: date-time
nullable
dateBuyerPreApproved

The date the buyer pre-approved this loan

string format: date-time
nullable
dateCreated

The date this record was initially created

string format: date-time
dateLastEvent

The date this record was last modified

string format: date-time
status
string
Allowed values: InServicing InDefault Terminal
terminalStatus
string
Allowed values: WrittenOff PaidOff
isForSale

Is the loan currently for-sale or not

boolean
sale
object
saleId

The unique id of the sale

string format: uuid
buyerPartnerId

The buyer partner id

string format: uuid
buyerPartnerName

The buyer partner’s NAME

string
nullable
status
string
Allowed values: Unlisted Listed InReview InReviewBuyerPreApproved InReviewSellerRequested BuyerCommitted SellerCommitted Sold SaleCancelled ReviewRejected
percent

Percent of loan for sale

number format: double
nullable
multiplier

Applies a percentage-based premium or discount as a multiplier

number format: double
nullable
serviceFee
One of:

Service fee agreed on during sale

object
type
required
string
Allowed values: PercentWithFloor Flat
percentAnnual
number format: double
floorFeeMonthly
number format: double
dateLastUpdated

Date the pending/sale was last updated

string format: date-time
nullable
dateRecommendedSaleClosed

Buyer Recommended Sale Close Date

string format: date-time
nullable
listingMetadata
object
loanAmount

The original amount of the loan

number format: double
nullable
percent

Percent of loan for sale

number format: double
nullable
multiplier

Applies a percentage-based premium or discount as a multiplier

number format: double
nullable
dateFunded

Date the loan was funded (close date / origination date)

string format: date-time
nullable
listingTag

The listing tag associated with this loan

string
nullable
interestRate
number format: double
nullable
termMonths
integer format: int32
nullable
interestOnlyPaymentAmount
number format: double
nullable
principalAndInterestPaymentAmount
number format: double
nullable
dateFirstPayment
string format: date-time
nullable
datePaymentTypeConversion
string format: date-time
nullable
isRefinance
boolean
nullable
serviceFee
One of:

If there are any service fees associated with this loan

object
type
required
string
Allowed values: PercentWithFloor Flat
percentAnnual
number format: double
floorFeeMonthly
number format: double
businessType
string
Allowed values: SoleProprietorship LLC Corporation NonProfit Partnership EmployeeOwned Other
businessAddressState
string
nullable
businessAddressCity
string
nullable
businessEmployeeCount
number format: double
nullable
businessIndustry
string
nullable
key
additional properties
privateMetadata
object
c2CLeadId

The associated Connect2Capital lead id

string format: uuid
nullable
businessName

Name of the business

string
nullable
businessAddress
object
line1
string
nullable
line2
string
nullable
city
string
nullable
state
string
nullable
postalCode
string
nullable
key
additional properties
buyerMetadata
object
tags

Buyer tags

Array<string>
nullable unique items
key
additional properties
loanDocuments

Loan’s documents

Array<object>
nullable
object
documentName

Name of the document

string
documentId

Document’s unique identifier

string format: uuid
tags

Document’s tags

Array<string>
nullable
dateUploaded

Date the document was uploaded

string format: date-time
nullable
errors
required

Resulting loan event issues, if any TODO: Create API model for this

Array<object>
object
message
string
index
integer format: int32
field
string
nullable
kind
string
Allowed values: None Warning Error IngestError

Forbidden

Not Found