Skip to content

Create a loan

Request

Start a loan, as a banker does with Start new loan. Send the product, the use-of-proceeds lines, the borrower and the primary contact. The bank derives the loan amount from the lines, the closing costs and the deposit, and starts the loan in the first Prequalify stage with the terms of the product. A borrower or contact is an existing business or person (businessId, personId) or a new one, with the same fields as POST /loans/{id}/businesses and POST /loans/{id}/people. A new party needs the write:businesses or write:people scope. Every other field of the loan is written with PATCH /loans/{id}. Only the built-in use-of-proceeds categories can start a loan.

Security
ApiKeyAuth
Headers
Idempotency-Keystring, <= 255 characters

Optional opaque key (e.g. a UUID) to make this write safely retryable. A replay with the same key returns the original response instead of repeating the side effect.

Bodyapplication/jsonrequired
productIdstring, non-emptyrequired

A product of the bank. A change of product applies the terms of the new product that the request does not send, and moves the loan to the matching stage of the new product.

lineItemsArray of objects, non-emptyrequired

The lines a banker enters. It replaces them: a line that is not in the list is removed. The guarantee fee and closing costs lines belong to the bank and keep their value, and so do lines the debt schedule derives. You can send back a useOfProceeds.lineItems array from GET /loans/{id} as it is. centsAmount of the loan does not change: send it with PATCH /loans/{id}.

borrowerobjectrequired
centsEstimatedClosingCostsinteger, [ 0 .. 9007199254740991 ]
Default:0
centsDepositinteger, [ 0 .. 9007199254740991 ]
Default:0
depositDispositionstring
Default:"refunded"
Enum:"refunded""applied"
monthsTerminteger, ( 0 .. 9007199254740991 ]
bpsFixedRateinteger, [ 0 .. 9007199254740991 ]
bpsPrimeRateinteger, [ 0 .. 9007199254740991 ]
bpsSpreadRateinteger, [ 0 .. 9007199254740991 ]
primaryContactobject

The person the bank contacts about the loan. Required when the borrower is a business. A person who is the borrower is the contact too.

actingBankerIdstring, non-empty

A banker from GET /bankers. The banker joins the loan team with the roles the bank set for the product, and the history names the banker. Leave it out for a loan with an empty team: fill it with PUT /loans/{id}/team.

curl -i -X POST \
  https://api.pioneerft.com/api/public/v1/loans \
  -H 'Authorization: Bearer <YOUR_API Key_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: string' \
  -d '{
    "productId": "string",
    "lineItems": [
      {
        "name": "string",
        "centsLoanAmount": 0,
        "nonLoanFunding": []
      }
    ],
    "centsEstimatedClosingCosts": 0,
    "centsDeposit": 0,
    "depositDisposition": "refunded",
    "monthsTerm": 1,
    "bpsFixedRate": 0,
    "bpsPrimeRate": 0,
    "bpsSpreadRate": 0,
    "borrower": {
      "businessId": "string",
      "business": {
        "name": "string",
        "ein": "string",
        "entityType": "C-Corp"
      },
      "personId": "string",
      "person": {
        "firstName": "string",
        "lastName": "string",
        "ssn": "string",
        "email": "user@example.com"
      }
    },
    "primaryContact": {
      "personId": "string",
      "person": {
        "firstName": "string",
        "lastName": "string",
        "ssn": "string",
        "email": "user@example.com"
      },
      "ownershipPercent": 0
    },
    "actingBankerId": "string"
  }'

Responses

The loan created, as GET /loans/{id} returns it

Bodyapplication/json
dataobject(PublicLoan)
Response
{ "data": { "id": "string", "loanNumber": "string", "status": "draft", "type": "business", "centsAmount": -9007199254740991, "centsMonthlyPayment": -9007199254740991, "monthsTerm": -9007199254740991, "monthsInterestOnly": -9007199254740991, "paymentFrequency": "weekly", "rateType": "fixed", "bpsRate": -9007199254740991, "bpsFixedRate": -9007199254740991, "bpsPrimeRate": -9007199254740991, "bpsSpreadRate": -9007199254740991, "rateDiscount": { "id": "string", "name": "string", "bpsRate": -9007199254740991 }, "borrowerName": "string", "purpose": "string", "purposeNarrative": "string", "applicationDate": "string", "closeDate": "string", "maturityDate": "string", "firstPaymentDate": "string", "product": { "id": "string", "name": "string" }, "stage": { "id": "string", "name": "string", "parent": { "id": "string", "name": "string" } }, "createdAt": "string", "updatedAt": "string", "centsDeposit": -9007199254740991, "depositDisposition": "refunded", "closingCostsMode": "estimate", "centsEstimatedClosingCosts": -9007199254740991, "monthsReamortizationTerm": -9007199254740991, "paymentType": "ACH", "prepaymentPenalty": [ { "year": -9007199254740991, "bpsRate": -9007199254740991 } ], "rateBenchmarkId": "string", "effectiveRateBenchmark": { "id": "string", "code": "string", "name": "string", "coreCode": "string", "bpsRate": -9007199254740991, "isActive": true }, "initialDisbursementDate": "string", "firstRateChangeDate": "string", "crmRecordNumber": "string", "documentRetentionRecordNumber": "string", "centsReferralFeeOverride": -9007199254740991, "bpsReferralFeeOverride": -9007199254740991, "referralFeePaidBy": "bank", "centsPackagingFeeOverride": -9007199254740991, "bpsPackagingFeeOverride": -9007199254740991, "packagingFeePaidBy": "bank", "centsInterestOnlyPayment": -9007199254740991, "centsAmortizingPayment": -9007199254740991, "interestMethod": "30/360", "yearBase": "Actual/365 Payments P&I", "ratePeriods": [ { "phaseName": "string", "monthsLength": -9007199254740991, "rateKind": "fixed", "rateBenchmarkId": "string", "monthsAdjustment": -9007199254740991 } ], "paymentSchedule": [ { "segmentType": "Interest Only", "numberOfPayments": -9007199254740991, "firstPaymentDate": "string", "centsPayment": -9007199254740991 } ], "metrics": { "hasOpenTasks": true, "hasMessages": true, "bpsGrossLtv": 0, "bpsNetLtv": 0 }, "loanTeam": [ { "role": { "id": "string", "name": "string", "label": "string" }, "banker": { "id": "string", "name": "string", "lastName": "string", "email": "string" } } ], "sbaDetails": { "program": "SBA_7A", "programLabel": "string", "processingMethod": "PLP", "processingMethodIsDefault": true, "approvalNumber": "string", "submittedToSbaDate": "string", "sbaApprovalDate": "string", "bpsGuarantee": -9007199254740991, "centsGuaranteeAmount": -9007199254740991, "centsGuaranteeFee": -9007199254740991, "centsGuaranteeFeeOverride": -9007199254740991, "guaranteeFeeOverrideReason": "string", "centsEffectiveGuaranteeFee": -9007199254740991, "bpsGuaranteeFeeRate": -9007199254740991, "waiverReason": "string", "feeScheduleFiscalYear": -9007199254740991, "feeNoticeReference": "string", "appliedRuleNames": [ "string" ], "guaranteeFeeFinanced": true, "secondaryMarketSold": true }, "referralSource": { "company": { "id": "string", "name": "string" }, "broker": { "id": "string", "name": "string", "lastName": "string", "email": "string", "phone": "string" }, "feesFrozen": true, "referralFee": { "centsAmount": -9007199254740991, "feeType": "flat", "bpsRate": -9007199254740991, "paidBy": "bank", "isOverridden": true }, "packagingFee": { "centsAmount": -9007199254740991, "feeType": "flat", "bpsRate": -9007199254740991, "paidBy": "bank", "isOverridden": true } }, "reporting": { "branch": { "id": "string", "name": "string" }, "codes": [ { "type": "ecoa", "id": "string", "code": "string", "label": "string", "active": true } ], "flexFieldCode": "string" }, "useOfProceeds": { "centsProjectCost": -9007199254740991, "centsRoundingPlug": -9007199254740991, "lineItems": [ { "name": "string", "label": "string", "centsProjectCost": -9007199254740991, "centsLoanAmount": -9007199254740991, "nonLoanFunding": [ { "source": "equity_injection", "centsAmount": -9007199254740991 } ], "isRefinance": true, "isGuaranteeFee": true, "isClosingCosts": true, "disbursementClass": "BORROWER", "source": "manual", "displayOrder": -9007199254740991, "notes": "string" } ] }, "credit": { "guarantors": [ { "person": { "id": "string", "firstName": "string", "lastName": "string" }, "hardPulls": [ { "id": "string", "pullType": "hard", "score": -9007199254740991, "bureauScores": [ {} ], "errors": [null], "notEntitled": true, "frozenBureaus": [null], "timeRun": "string", "fileId": "string" } ], "softPulls": [ { "id": "string", "pullType": "hard", "score": -9007199254740991, "bureauScores": [ {} ], "errors": [null], "notEntitled": true, "frozenBureaus": [null], "timeRun": "string", "fileId": "string" } ] } ], "authorization": { "date": "string", "recordedBy": { "type": "customer", "name": "string" }, "authorizedVia": [ "prequalify" ] } }, "dueDiligence": { "entities": [ { "type": "business", "id": "string", "name": "string", "roles": [ "string" ], "items": [ { "serviceId": "string", "name": "string", "integration": "docusign", "result": "string", "timeRun": "string", "fileId": "string" } ] } ] }, "uccFiling": { "configured": true, "filings": [ { "id": "string", "status": "string", "debtorName": "string", "filingState": "string", "collateralDescription": "string", "date": "string" } ] }, "amortization": { "summary": { "totalPayments": -9007199254740991, "centsTotalScheduled": -9007199254740991, "centsTotalInterest": -9007199254740991, "centsTotalPrincipal": -9007199254740991 }, "centsBalloonPayment": -9007199254740991, "calculatedAt": "string", "schedule": [ { "period": -9007199254740991, "date": "string", "centsPayment": -9007199254740991, "centsPrincipal": -9007199254740991, "centsInterest": -9007199254740991, "centsBalance": -9007199254740991 } ] } } }