Skip to main content

Make an Inquiry

POST 
/product/inquiry

The "Make an Inquiry" section allows users to submit a request for credit information based on provided applicant details. By filling in required applicant information, users can retrieve borrower and co-borrower credit profiles, employment history, credit scores, public records, trade lines, collections data, inquiries, and summary reports. This section enables users to access comprehensive credit information for decision-making processes.

Request​

Header Parameters

    Idempotency-Key stringrequired

    A unique, idempotent key. We recommend to use a guid

    Agc-Tenant-Id stringrequired

    The tenant ID provided by Agility Credit.

    Agc-User-Id stringrequired

    The requestor user ID.

    Agc-Applicant-Id string

    If passed, will assign the report to that applicant. If not, will create a new applicant ID

Body

required

Inquiry request payload

    bureau_idstringrequired

    Possible values: [equifax, transunion, experian]

    pull_typestringrequired

    Possible values: [prequal, hard]

    applicant_main

    object

    required

    first_namestringrequired

    The first name of the applicant. [REQUIRED]

    middle_namestring

    The middle name of the applicant. Middle name can be an initial.

    last_namestringrequired

    The last name of the applicant. [REQUIRED]

    ssnstring

    The SSN of the applicant. Required if pull_type is set to 'hard'.

    dobstring

    The date of birth of the applicant. Required if pull_type is set to 'hard'.

    phonestring

    The phone number of the applicant.

    emailstring

    The email address of the applicant.

    addressstringrequired

    The address of the applicant. The format is '{house_number} {street_name} {street_type} {direction}'. street_type and direction are optional. [REQUIRED]

    zipstringrequired

    The ZIP code of the applicant. [REQUIRED]

    statestringrequired

    The state of the applicant. [REQUIRED]

    citystringrequired

    The city of the applicant. Abbreviation of the city name. E.g 'NY'. [REQUIRED]

    applicant_co

    object

    first_namestringrequired

    The first name of the applicant. [REQUIRED]

    middle_namestring

    The middle name of the applicant. Middle name can be an initial.

    last_namestringrequired

    The last name of the applicant. [REQUIRED]

    ssnstring

    The SSN of the applicant. Required if pull_type is set to 'hard'.

    dobstring

    The date of birth of the applicant. Required if pull_type is set to 'hard'.

    phonestring

    The phone number of the applicant.

    emailstring

    The email address of the applicant.

    addressstringrequired

    The address of the applicant. The format is '{house_number} {street_name} {street_type} {direction}'. street_type and direction are optional. [REQUIRED]

    zipstringrequired

    The ZIP code of the applicant. [REQUIRED]

    statestringrequired

    The state of the applicant. [REQUIRED]

    citystringrequired

    The city of the applicant. Abbreviation of the city name. E.g 'NY'. [REQUIRED]

    report_format

    object

    required

    oneOf

    string

    Possible values: [json, html, xml, raw, pdf]

    featuresarray

Responses​

Inquiry processed succesfully

Response Headers

  • Agc-Applicant-Id

    string

    The applicant id

  • Source-Ip

    string

    The source IP

  • Agc-Transaction-Id

    string

    A unique identifier for this transaction.

  • X-Rate-Limit

    integer

    The current limit on a 5-minute window.

  • X-Rate-Limit-Remaining

    integer

    The remaining calls on a 5-minute window.

  • Timestamp

    string

    The timestamp of the request reception.

Schema

    oneOf

    APPLICANT INFORMATION

    object[]

    required

  • Array [

    • Borrower/CoBorrowerstringrequired
    SSNstringrequired
    DOBstring
    Addressstringrequired
    Citystringrequired
    Statestringrequired
    Zipstringrequired

  • ]

    • BORROWERS IDENTIFICATIONS

    object[]

  • Array [

    • AKAstringrequired

  • ]

    • BORROWERS FORMER ADDRESSES

    object[]

  • Array [

    • Namestringrequired
    Previous Addressstringrequired
    Date Reporteddaterequired

  • ]

    • BORROWERS EMPLOYMENT

    object[]

  • Array [

    • Employerstringrequired
    Employer Addressstring
    Reported Datedaterequired

  • ]

    • CREDIT REPORT SUMMARY

    object[]

    required

  • Array [

    • Categorystringrequired
    Countinteger
    Openinteger
    Closedinteger
    Balanceinteger
    Paymentsinteger
    Past Dueinteger
    Currentinteger
    30 daysinteger
    60 daysinteger
    90+ daysinteger
    Unratedinteger
    Revolving Credit Usagestring
    Disputed Accountsinteger
    Public Records (BKs)integer
    Reposessionsinteger
    Collectionsinteger
    Foreclosuresinteger
    Inquiries (Last 2 Months)integer

  • ]

    • CREDIT SCORES

    object[]

  • Array [

    • Score/Modelstringrequired

    Factors

    object[]

    required

  • Array [

    • Scorestringrequired
    Reasonstringrequired

  • ]

  • ]

    • PUBLIC RECORDS (BANKRUPTCIES)

    object[]

  • Array [

    • Court Namestringrequired
    Docketstringrequired
    ECOAstringrequired
    Statusstringrequired
    Filed Datedaterequired
    Reported Datedaterequired

  • ]

    • TRADELINES

    object[]

  • Array [

    • creditorstringrequired

    Creditor of the trade line with account number if included.

    ind_jointstringrequired

    Possible values: [Undesignated, Individual, Joint, Authorized User, Joint, Co-maker, On Behalf, Maker, Deceased, Undesignated - Terminated, Joint - Terminated, Authorized User - Terminated, Joint - Terminated, Co-maker - Terminated, On Behalf - Terminated, Maker - Terminated, Individual - Terminated]

    acct_typestringrequired

    Possible values: [Open 30 Day, Revolving, Installment, Mortgage, Line of Credit]

    open_closedstringrequired

    Possible values: [Open, Closed]

    closed_datestringrequired

    Closed date in format YYYY-MM-DD

    open_datestringrequired

    Open date in format YYYY-MM-DD

    reported_datestringrequired

    Reported date in format YYYY-MM-DD

    current_statusstringrequired

    Possible values: [Current, Paid/Closed]

    balancenumberrequired

    Full dolar balance

    high_creditnumberrequired

    Full dolar high credit

    credit_limitnumberrequired

    Full dolar credit limit

    monthly_paymentnumberrequired

    Full dolar monthly payment

    days_30integerrequired
    days_60integerrequired
    days_90integerrequired
    bureaustringrequired

    Bureau ID followed by 'Borr' or 'CoBorr' to diferiantiate between main and co applicant

    notesstringrequired

    Notes / Remarks

    remainingstringrequired
    loan_categorystringrequired

    The Loan Category

    payment_historystringrequired

    Payment History

  • ]

    • COLLECTIONS

    object[]

  • Array [

    • creditorstringrequired
    ind_jointstringrequired
    acct_typestringrequired
    open_closedstringrequired
    closed_datestringrequired
    open_datestringrequired
    reported_datestringrequired
    current_statusstringrequired
    balancenumberrequired
    high_creditnumberrequired
    credit_limitnumberrequired
    monthly_paymentintegerrequired
    days_30integerrequired
    days_60integerrequired
    days_90integerrequired
    bureaustringrequired
    notesstringrequired
    remainingstringrequired
    loan_categorystringrequired
    payment_historystringrequired

  • ]

    • INQUIRIES (Last 24 Months)

    object[]

  • Array [

    • Namestringrequired
    Industrystringrequired
    Datestringrequired
    Subscriber Codestringrequired

  • ]

    • ALERTS/MESSAGES

    object[]

    required

  • Array [

    • Message Textstringrequired
    Message Typestringrequired
    Date Reportedstring

  • ]

    • summary

    object

    required

    Borrower

    object

    required

    Profile Summary

    object

    required

    Overall Credit Scorestringrequired
    Total Number of Accountsintegerrequired
    Total Number of Active Accountsintegerrequired
    Total Number of Closed Accountsintegerrequired
    Total Credit Limitnumberrequired
    Total Credit Balancenumberrequired
    Total Past Duenumberrequired
    Total Monthly Paymentnumberrequired
    Total Collections Balancenumberrequired
    Total Charge-off Balancenumberrequired