createLead

Mutation

Submit a new lead with applicant information for processing and qualification.

This mutation initiates the lead processing pipeline including:

Deduplication check
TrustedForm verification (if certificate ID provided)
Monevo Credit pull and eligibility scoring
Bid calculation for qualified leads
Can also be configured to skip all validation

createLead waits for workflow completion and returns the completed result. Processing behavior and CRM submission path are internally configured based on lead partner requirements.

Mutation Signature

mutation {
  createLead(input: LeadInput!): CreateLeadResponse!
}

mutation CreateLead($input: LeadInput!) {
  createLead(input: $input) {
    id
    resultCode
    note
    partnerLeadId
    bidValue
  }
}

Example Variables:

{
  "input": {
    "firstName": "tony",
    "lastName": "tiger2",
    "email": "tony.tiger2@monevo.com",
    "homePhone": "4028319225",
    "cellPhone": "4028319225",
    "address1": "PO BOX 1021",
    "city": "SLATERSVILLE",
    "state": "RI",
    "zipCode": "02876",
    "residenceTypeId": 2,
    "monthsAtAddress": 12,
    "monthlyRent": 50000,
    "incomeSourceId": 1,
    "payFrequencyId": 4,
    "monthlyIncome": 12345,
    "grossAnnualIncome": 1300000,
    "employerName": "Test Employer",
    "monthsAtEmployer": 36,
    "loanAmount": 200000000,
    "loanPurposeId": 1,
    "estimatedDebt": 25000,
    "termsConsent": true,
    "marketingOptIn": true,
    "siteURL": "app.monevo.us",
    "clientIP": "000.000.000.000",
    "coApplicant": false,
    "leadId": "414141222",
    "trustedformCertificateID": "981eef90ec965dd5a139170a4ad935b8b057baae"
  }
}

Example Response

{
  "data": {
    "createLead": {
      "id": "d5faed99-51c3-4181-959e-5557d1eef042",
      "resultCode": 1018,
      "note": "Lead processing complete",
      "partnerLeadId": "414141222",
      "bidValue": null
    }
  }
}

Arguments

Argument	Type	Description
`input`	`LeadInput!`	Input for creating a new lead with applicant information. All required fields must be provided for successful lead submission.

Input Types

`LeadInput`

Input for creating a new lead with applicant information. All required fields must be provided for successful lead submission.

Required Fields:

Field	Type	Description
`firstName`	`String!`	Applicant’s legal first name as it appears on official documents.
`lastName`	`String!`	Applicant’s legal last name as it appears on official documents.
`email`	`String!`	Applicant’s email address for communication.
`homePhone`	`String!`	Applicant’s primary home phone number. FORMAT: 10-digit number without formatting (e.g., 9496779225). Avoid reserved exchanges like 555 or 123.
`address1`	`String!`	Primary street address line 1.
`city`	`String!`	City of residence.
`state`	`String!`	Two-letter US state code. FORMAT: Two uppercase letters (e.g., CA, TX, NY)
`zipCode`	`String!`	Five-digit ZIP code. FORMAT: 5 digits (e.g., 90210)

Optional Fields:

Field	Type	Description
`dateOfBirth`	`String`	Applicant’s date of birth. FORMAT: YYYY-MM-DD (e.g., 1990-01-15) NOTE: Optional — Monevo no longer requires this field
`cellPhone`	`String`	Applicant’s cell∕mobile phone number. FORMAT: 10-digit number without formatting
`workPhone`	`String`	Applicant’s work phone number. FORMAT: 10-digit number without formatting
`address2`	`String`	Street address line 2 (apartment, suite, unit, building, floor, etc.)
`residenceTypeId`	`Int`	Residence type identifier indicating ownership status. • 1: Home Owner • 2: Rent • 3: Living with Family • 4: Other
`monthsAtAddress`	`Int`	Number of months applicant has lived at current address.
`monthlyRent`	`Int`	Monthly rent or mortgage payment amount in whole dollars.
`socialSecurityNumber`	`String`	Applicant’s Social Security Number for credit verification. FORMAT: 9 digits without dashes (e.g., 123456789) NOTE: Required for credit pull and qualification AUTO-SANITIZED: Non-digit characters (dashes, spaces) are automatically removed
`incomeSourceId`	`Int`	Income source identifier. • 1: Employed • 2: Social Security • 3: Pension • 4: Disability • 5: Self Employed • 6: Student • 7: Unemployed
`payFrequencyId`	`Int`	Pay frequency identifier indicating how often applicant is paid. • 1: Weekly • 2: Every two weeks • 3: Twice a month • 4: Monthly • 5: 4 Weekly • 6: Other
`monthlyIncome`	`Int`	Monthly income amount in whole dollars before taxes.
`grossAnnualIncome`	`Int`	Gross annual income in whole dollars before taxes.
`employerName`	`String`	Current employer name.
`monthsAtEmployer`	`Int`	Number of months employed at current employer.
`loanAmount`	`Int`	Requested loan amount in whole dollars.
`estimatedDebt`	`Int`	Partner-supplied estimated debt amount in whole dollars. Used as a fallback when the system cannot determine debt from credit pull or product codes.
`unsecuredDebt`	`Int`	Partner-supplied unsecured debt amount in whole dollars.
`maxUnsecuredDebt`	`Int`	Partner-supplied maximum unsecured debt amount in whole dollars.
`loanPurposeId`	`Int`	Loan purpose identifier. • 1: Debt Consolidation • 2: Home improvement ∕ Pool ∕ Solar • 3: Vacation ∕ Travel • 4: New auto purchase • 5: Large Purchase • 6: Pay off credit cards • 7: Student Loan Refinancing • 8: Education • 9: Special Occasion • 10: Cosmetic Procedures • 11: Moving and Relocation • 12: Household Expenses • 13: Medical∕Dental…
`termsConsent`	`Boolean`	Whether the applicant has consented to terms and conditions. Must be true for lead to be processed. DEFAULT: false if not provided
`marketingOptIn`	`Boolean`	Whether the applicant has opted in to receive marketing communications. DEFAULT: false if not provided
`affiliateAppID`	`String`	Partner’s unique affiliate application ID for tracking and attribution. FORMAT: Provided during partner onboarding
`siteURL`	`String`	Full URL of the website where the lead was submitted. Used for compliance and tracking purposes.
`siteIP`	`String`	IP address of the server hosting the lead submission form.
`clientIP`	`String`	IP address of the applicant’s device at time of submission. Used for fraud detection and compliance.
`ref`	`String`	Partner’s custom reference identifier for internal tracking.
`coApplicant`	`Boolean`	Whether the application includes a co-applicant. If true, co-applicant fields should be populated. DEFAULT: false if not provided
`coApplicantFirstName`	`String`	Co-applicant’s legal first name. if coApplicant is true
`coApplicantLastName`	`String`	Co-applicant’s legal last name. if coApplicant is true
`coApplicantDateOfBirth`	`String`	Co-applicant’s date of birth. FORMAT: YYYY-MM-DD (e.g., 1990-01-15)
`coApplicantAnnualIncome`	`Int`	Co-applicant’s gross annual income in whole dollars.
`coApplicantAddress1`	`String`	Co-applicant’s primary street address line 1.
`coApplicantAddress2`	`String`	Co-applicant’s street address line 2.
`coApplicantCity`	`String`	Co-applicant’s city of residence.
`coApplicantState`	`String`	Co-applicant’s two-letter US state code.
`coApplicantZipCode`	`String`	Co-applicant’s five-digit ZIP code.
`leadId`	`String`	Partner’s external lead ID for correlation between systems. This value is returned as partnerLeadId in responses.
`trustedformCertificateID`	`String`	TrustedForm certificate ID for TCPA consent verification. Obtained from TrustedForm JavaScript snippet on the lead form. FORMAT: TrustedForm certificate UUID

Response Type

Returns: CreateLeadResponse!

`CreateLeadResponse`

Response returned from the createLead mutation. Contains the lead ID, completed workflow result code, and processing notes.

Field	Type	Description
`id`	`ID!`	Unique internal lead identifier. Use this ID for submitLead or status lookup.
`resultCode`	`Int!`	Completed workflow result code returned from createLead.
`note`	`String!`	Human-readable note about the processing result. May contain additional context about the result code.
`partnerLeadId`	`String`	Partner’s external lead ID (from leadId input field) echoed back for correlation.
`bidValue`	`String`	Calculated bid value for qualified leads. • null: Lead did not qualify • “No Bid Available”: Qualified but no bid settings configured • “$X.XX”: Actual bid amount (e.g., “$25.00”)