Debt Consolidation

Use our API to pre-qualify consumers for a consolidation loan.

Request Consolidation Offers

mutation($details: ConsolidationInput!) {
  createConsolidation(request: $details)
}

Variables:

{
  "details": {
    "annualIncome": "100000",
    "citizenship": "US_CITIZEN",
    "employmentStartDate": "2020-01-01",
    "employmentStatus": "SALARY",
    "housingMonthlyCost": "2000",
    "housingStatus": "OWN",
    "loanAmount": "30000",
    "consumerId": "df8f7e1b-62f0-4297-a6bc-042ac371ad72"
  }
}

List Consolidation Offers

Use the UUID returned from the Request Consolidation Offers query (returned in the data under the key "createConsolidation") to query consolidation loan offers for the consumer:

query($consolidationId: UUID4!) {
  consolidationOffers(uuid: $consolidationId) {
    annualFee
    apr
    description
    disclosure
    interestRate
    lenderEmail
    lenderName
    lenderPhone
    loanAmount
    loanTerm
    messageToBorrower
    monthlyPayment
    originationFee
    rateType
    redirectUrl
    summary {
      result
      initialPayment
      interest
      months
      name
      overpayment
    }
  }
}

Variables:

{
  "consolidationId": "2dd13807-7407-43b3-af54-f352c6ea8aaa"
}

List Consolidation Submissions

The history of submitted applications for pre-qualified loan offers (created via Nexus or a createConsolidation mutation) can be queried through the consumer they belong to. This is useful for checking the status of the application and, if the consumer selected an offer, the status of the resulting loan application.

query($consumerId: UUID4!) {
  consumer(uuid: $consumerId) {
    consolidationSubmissions {
      uuid
      address1
      address2
      annualIncome
      applicationLoanAmount
      applicationReceivedAt
      approvedAmount
      approvedApr
      approvedAt
      approvedTermInMonths
      citizenship
      city
      closedLoanAmount
      dateOfBirth
      debtIds
      email
      employmentStartDate
      employmentStatus
      firstName
      fundedApr
      fundedAt
      fundedTermInMonths
      housingMonthlyCost
      housingStatus
      issues
      lastName
      loanAmount
      offersDeliveredAt
      phone
      ssn
      stateOfResidence
      status
      withdrawnAt
      zipcode
    }
  }
}

Example variables should include the UUID of the consumer:

{
  "consumerId": "df8f7e1b-62f0-4297-a6bc-042ac371ad72"
}

Types 🚧

Explore our complete GraphQL schema in the GraphiQL UI available at https://payitoff-sandbox.io/api/graphql-playground (just click the "< Docs" tab at right).