Web API Endpoints

Authenticate User

POST https://stg.dealerallyapi.com/v1/users/authenticate-user

Retrieves user details and Authorization and Refresh token.

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

{
    "dealer": "DEALER ALLY - TEST FILE",
    "role": "Sales Representative",
    "name": "User Test",
    "email": "[email protected]",
    "permissions": [
        "can_read_own_applications",
        "can_create_applications"
    ],
    "status": "SUCCESS",
    "id_token": "eyJraWQiOiIzalBXN2ZZWVRqZj...",
    "refresh_token": "eyJjdHkiOiJKV1QiLCJlbmMiOiJB...",
    "access_token": "eyJraWQiOiJmSTZlU2k5Y1ZRYU8....",
    "expires_in": 3600,
    "dealer_id": "DID-0023",
    "dealer_permissions": [
        "can_create_applications"
    ]
}



{
    "status": "USER_NOT_FOUND",
    "messages": [
        "Info: There's no users associated to this DealerId."
    ],
    "uri": "/users/authenticate-user"
}

Body:

{
	"username" : "user01",
	"password" : "Password$01"
}

Get New Token

POST https://stg.dealerallyapi.com/v1/users/new-token

This endpoint allows you to get a new token.

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

{
    "status": "success",
    "id_token": "eyJraWQiOiIzalBXN2ZZWVR...",
    "access_token": "eyJraWQiOiJmSTZlU2k5Y1ZRYU...",
    "expires_in": 3600
}

Body:

{
	"username" : "usertest",
	"refresh_token" : "eyJjdHkiOiJKV1QiLCJlbmMiOiJBMjU..."
}

Create Basic User

POST https://stg.dealerallyapi.com/v1/users/create-basic-user

This endpoint allows you to create a new basic user. This user won't have credentials to access DealerAlly API, but it can be used to send notifications of status changes by setting the field AssignedUserEmailAddress when submitting a new Loan Application.

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

Authorization

string

Authorization token.

username*

string

Username provided by DealeryAlly.

{
    "status": "SUCCESS",
    "messages": [
        "Info: User created succesfully"
    ],
    "uri": "/users/create-basic-user"
}

OR

{
    "status": "USER_ALREADY_EXISTS",
    "messages": [
        "Info: User already exists."
    ],
    "uri": "/users/create-basic-user"
}

Body:

{
	"Email" : "[email protected]",
	"FirstName" : "Julian",
	"LastName" : "Mars",
	"PhoneNumber" : "7234567890",
  "CCEmailList" : "[email protected]; [email protected]" // Optional
}

Update Basic User

POST https://stg.dealerallyapi.com/v1/users/update-basic-user

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

Authorization

string

Authorization token.

username

string

Username provided by DealeryAlly.

{
    "status": "SUCCESS",
    "messages": [
        "Info: User updated successfully."
    ],
    "uri": "/users/update-basic-user"
}

OR

{
    "status": "USER_NOT_FOUND",
    "messages": [
        "Info: User not found with the email provided or username provided has not access to user in payload."
    ],
    "uri": "/users/update-basic-user"
}

OR

{
    "status": "EMAIL_REQUIRED",
    "messages": [
        "Info: Email is required."
    ],
    "uri": "/users/update-basic-user"
}

Body:

{
	"Email" : "[email protected]",
	"FirstName" : "Jules",
	"LastName" : "Mars",
	"PhoneNumber" : "9234567431",
  "CCEmailList" : "[email protected]; [email protected]; [email protected]"  // Optional
}

Get list of Basic Users

GET https://stg.dealerallyapi.com/v1/users/get-basic-users

This endpoint is deprecated, please use "Get list of Active Users" instead.

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

Authorization

string

Authorization token.

username*

string

Username provided by DealeryAlly.

[
    {
        "PhoneNumber": "6512479###",
        "Email": "[email protected]",
        "FirstName": "BasicUser",
        "LastName": "Test",
        "CreatedDate": "2021-06-25 02:57",
        "Status": "Active"
    },
    {
        "PhoneNumber": "8234567###",
        "Email": "[email protected]",
        "FirstName": "Carl",
        "LastName": "Jones",
        "CreatedDate": "2021-06-09 10:58",
        "Status": "Active"
    },
    {
        "PhoneNumber": "6512479###",
        "Email": "[email protected]",
        "FirstName": "Loise",
        "LastName": "Perth",
        "CreatedDate": "2021-03-17 12:13",
        "Status": "Active"
    }
]

Get list of Active Users

GET https://stg.dealerallyapi.com/v1/users/get-active-users

Returns a list of active users (both full users and basic users)

Headers

Name
Type
Description

x-api-key*

string

This key is provided by DealerAlly

Authorization*

string

Authorization token

username*

string

Username provided by DealerAlly

[
    {
        "PhoneNumber": "6512479###",
        "Email": "[email protected]",
        "FirstName": "BasicUser",
        "LastName": "Test",
        "CreatedDate": "2021-06-25 02:57",
        "Status": "Active"
    },
    {
        "PhoneNumber": "8234567###",
        "Email": "[email protected]",
        "FirstName": "Carl",
        "LastName": "Jones",
        "CreatedDate": "2021-06-09 10:58",
        "Status": "Active"
    },
    {
        "PhoneNumber": "6512479###",
        "Email": "[email protected]",
        "FirstName": "Loise",
        "LastName": "Perth",
        "CreatedDate": "2021-03-17 12:13",
        "Status": "Active"
    }
]

Get list of applicants

GET https://stg.dealerallyapi.com/v1/application/get-applicants

This endpoint retrieves a list of applicants depending on the user's role.

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

Authorization

string

Authorization token.

username

string

Username provided by DealerAlly.

[
    {
        "FullName": "Clara Cespedess",
        "FirstName": "Clara",
        "LastName": "Cespedess",
        "PrimaryPhone": "1236547899",
        "ApplicantId": "A-00504",
        "HasCoApplicant": false,
        "IsIssueStatePresent": false,
        "IsIssueDatePresent": false,
        "EmailAddress": "[email protected]"
    },
    {
        "FullName": "Pedro Paramo",
        "FirstName": "Pedro",
        "LastName": "Paramo",
        "PrimaryPhone": "1236547895",
        "ApplicantId": "A-00503",
        "HasCoApplicant": false,
        "IsIssueStatePresent": false,
        "IsIssueDatePresent": false,
        "EmailAddress": "[email protected]"
    },
    {
        "FullName": "DocTest TestNine",
        "FirstName": "DocTest",
        "LastName": "TestNine",
        "PrimaryPhone": "6515551212",
        "ApplicantId": "A-00502",
        "HasCoApplicant": false,
        "IsIssueStatePresent": false,
        "IsIssueDatePresent": false,
        "EmailAddress": "[email protected]"
    }
]


OR

{
    "status": "USER_NOT_FOUND",
    "messages": [
        "Info: User not found in ORG."
    ],
    "uri": "/applications/get-applicants"
}

Get applicant details

GET https://stg.dealerallyapi.com/v1/application/get-applicant-details/:applicantId

Path Parameters

Name
Type
Description

applicantId

string

Applicant ID: A-######.

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

Authorization

string

Authorization token.

username

string

Username provided by DealerAlly.

{
    "State": "AZ",
    "FirstName": "Clara",
    "LastName": "Cespedess",
    "Address1": "Cra 34",
    "PostalCode": "45219",
    "City": "Phoenix",
    "PrimaryPhone": "1236547899",
    "HasCoApplicant": false,
    "PrimaryPhoneType": "Cell",
    "SecondaryPhoneType": "Home",
    "IsIssueStatePresent": false,
    "SecondaryPhone": "1236547899",
    "IdentificationType": "Unavailable",
    "EmploymentType": "Employed",
    "IdentificationIssueState": "AK",
    "IsIssueDatePresent": false,
    "EmailAddress": "[email protected]"
}


OR

{
    "status": "APPLICANT_NOT_FOUND",
    "messages": [
        "Info: No applicant was found."
    ],
    "uri": "/application/get-applicant-details"
}

Submit Loan Application

POST https://stg.dealerallyapi.com/v1/application

This endpoint allows you to create a new application.

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

Authorization

string

Authorization token.

username

string

Username provided by DealerAlly.

{
    "Status": "FilledOut",
    "Messages": [
        "Info: It may take a few minutes."
    ],
    "URI": "/application/status/LA000219",
    "ApplicationId": "LA######",
    "ApplicantId": "A-#####",
    "CoApplicantId": "A-#####",
    "FinancialInstitutions": [
        {
            "Name": "Aqua Finance",
            "Id": "FI-0001",
            "ParametersProperlySet": true,
            "CanDealerCreateCompleteApplications": true
        },
        {
            "Name": "Pinnacle Finance",
            "Id": "FI-0002",
            "ParametersProperlySet": true,
            "CanDealerCreateCompleteApplications": true
        }
    ],
    "UUID": "XXXXX#####XXX#X###"
}

OR

{
    "status": "APPLICANT_ALREADY_EXISTS",
    "messages": [
        "Info: Duplicated OR if you need to update an Applicant be sure an applicantId is being sent."
    ],
    "uri": "/application"
}

OR

{
    "Message": "There's some errors validating input data.",
    "Errors": [
        ...
        "IdentificationExpirationDate: must be a future date",
        "DateOfBirth: must not be null"
        ...
    ]
}

OR in case an ApplicantId is sent, there's two possible error responses:

{
    "status": "APPLICANT_ID_DOES_NOT_EXIST",
    "messages": [
        "Info: Duplicated OR if you need to update an Applicant be sure an applicantId is being sent."
    ],
    "uri": "/application"
}

Some considerations

  • If the application doesn't have a co-applicant the field HasCoApplicant should be false and you should not send the CoApplicant object.

  • Use the values in the Enums Section when needed.

  • Phones have 10 digits with no special characters.

  • Dates format: yyyy-MM-dd

  • FinancialInstitutionId field values: FI-0001 (AquaFinance), FI-0002 (Pinnacle).

Event-Based Status Updating (API Callback)

In order to use this functionality, new application requests would need to include the field “CallbackURL” in the payload. This URL (dealer’s endpoint) will be called every time the Loan Application changes its status. DealerAlly will send a POST request with a JSON payload with this structure:

{ "Status" : "Denied", "Tier" : "GOLD", "Stipulations" : [ "Maximum Loan Term 84 months", "Proof of Homeownership Required for Borrower" ], "Messages" : [ { "MessageType": "Condition", "Label": "Proof of Home Ownership Required", "IsMet": true, "Text": "Validation of Borrower Home Ownership is required via a copy of a HUD or deed, or a closing statement confirming the customer owns the residence. Call our credit department for assistance in verifying home ownership." } ], "UUID": "XXXXX#####XXX#X###",

"ApplicationId": "LAXXXXXX",

"BuyRate": "100.00%" }

MessageType Values:

  • ApprovalMessage

  • Condition

  • Hint

  • Reason

  • Stipulation

  • DenialMessage

  • Error

The UUID field is also found in Get Application DetailsandGet Applications By Dealerendpoints.

Body:

  • "FinancialInstitutionID" must be "FI-0001"

  • Don't send the DownPayment field when there's none.

  • AquaFinance testing API accepts only these Social Security Numbers ranges:

    100000101 to 100000105 -> Approved. 100000106 to 100000110 -> Denied. 100000111 to 100000113) -> Pending.

  • AmountFinanced is calculated: AmountFinanced = SellingPrice + SalesTax - DownPayment.

  • AssignedUserEmailAddress is required. It is used to connect a LoanApp to a Basic User so that the user’s email can be passed on to DocuSign for Dealer e-signing and is used as a part of Basic User notifications.

  • Optional fields: MiddleInitial, CallbackURL.

  • Past date fields: IdentificationIssuedDate, HireDate, DateOfBirth (over 18 years old).

  • Future date fields: IdentificationExpirationDate.

  • Fields constraints: PostalCode (5 digits), CellPhone (10 digits), BusinessPhone (10 digits), SocialSecurityNumber (9 digits).

  • Include the "CallbackURL" field if your system can manage an endpoint to receive Status updates.

Identification Types

  • Unavailable: Only IdentificationType field should be sent.

  • DriversLicense: IdentificationNumber and IdentificationExpirationDate are required. IdentificationIssuedDate and IdentificationIssueState depend on IsIssueDatePresent and IsIssueStatePresent.

  • StateId: IdentificationNumber and IdentificationExpirationDate are required. IdentificationIssuedDate and IdentificationIssueState depend on IsIssueDatePresent and IsIssueStatePresent.

  • UnitedStatesMilitaryId: IdentificationNumber is required. IdentificationIssuedDate, IdentificationExpirationDate depend on IsIssueDatePresent and ExpirationDateUnavailable.

  • UnitedStatesPassport: IdentificationNumber and IdentificationExpirationDate are required. IdentificationIssuedDate depends on IsIssueDatePresent.

  • PermanentResidencyCard: IdentificationNumber, IdentificationIssuedDate, IdentificationIssueState and IdentificationExpirationDate are required.

Employment Types

  • Unemployed: Only EmploymentType field should be sent.

  • Employed: CurrentEmployer, Occupation, HireDate, GrossMonthlyIncome are required.

  • Retired: Only EmploymentType field should be sent.

  • SelfEmployed: Occupation, HireDate, GrossMonthlyIncome are required.

Important:

  • In order to create a new application with an existing applicant, please include the field ApplicantId in the Applicant object. The ApplicantId can be obtained from the Get list of applicants endpoint. Creating a new loan application for an existing applicant is commonly done when re-submitting an existing applicant along with a co-applicant, or when submitting an existing applicant to another lender.

  • Field AssignedUserEmailAddress can be set to an existing basic user email. By doing this, DealerAlly will send status change notifications to that user and its CCEmailList.

{
  "Applicant": {
    "HasCoApplicant": true,
    "FirstName": "Maya",
    "LastName": "Angelou",
    "SocialSecurityNumber": "100000103",
    "EmailAddress": "[email protected]",  // Emails of applicant and co-applicant must be different.
    "DateOfBirth": "1997-07-21",
    "Address1": "3 Last St",
    "City": "Phoenix",
    "State": "AZ", // Enum
    "PostalCode": "12581",
    "CellPhone": "5412339129", //CellPhone and BusinessPhone must be different.
    "BusinessPhone": "5412339522",  // Optional. CellPhone and BusinessPhone must be different.
    "IdentificationType": "DriversLicense", // Enum
    "IdentificationNumber": "46531",
    "IsIssueDatePresent": "true",
    "IsIssueStatePresent": "true",
    "IdentificationIssueState": "AZ", // Enum
    "IdentificationIssuedDate": "2020-08-04",
    "IdentificationExpirationDate": "2020-11-14",
    "ExpirationDateUnavailable": false,
    "EmploymentType": "Employed", // Enum
    "CurrentEmployer": "The Sun",
    "Occupation": "Writer",
    "HireDate": "2010-01-08",
    "GrossMonthlyIncome": 12300,
    "HomeValue": 29230,
    "ResidenceType": "OwnWithMortgage", // Enum
    "ResidenceMonthlyPayment": 4600,
    "AdditionalIncomeSources": [
      {
        "AdditionalIncomeSource": "Investments", // Enum
        "Description": "Test",
        "Amount": 8200
      }
    ],
    "ApplicantId": "A-#####", // Use only to create a new LoanApplication from an existing Applicant.
    "LivingSinceCurrentResidence": "2019-03-09"
  },
  "CoApplicant": {
    "IdentificationNumber": "1464545",
    "IsIssueDatePresent": "false",
    "IsIssueStatePresent": "true",
    "IdentificationIssueState": "AZ", // Enum
    "IdentificationIssuedDate": "1990-03-15",
    "IdentificationExpirationDate": "2021-02-12",
    "ExpirationDateUnavailable": false,
    "CoApplicantType": "Spouse", // Enum
    "FirstName": "Mark",
    "LastName": "Twain",
    "SocialSecurityNumber": "100000102",
    "EmailAddress": "[email protected]",  // Emails of applicant and co-applicant must be different.
    "DateOfBirth": "1997-02-10",
    "Address1": "4 Last St",
    "City": "Phoenix",
    "State": "AZ", // Enum
    "PostalCode": "12584",
    "CellPhone": "2145224333",  //CellPhone and BusinessPhone must be different.
    "BusinessPhone": "2145224444",  // Optional. CellPhone and BusinessPhone must be different.
    "IdentificationType": "StateId", // Enum
    "EmploymentType": "SelfEmployed", // Enum
    "Occupation": "Writer",
    "HireDate": "2018-03-10",
    "GrossMonthlyIncome": 17130,
    "HomeValue": 122000,
    "ResidenceType": "OwnWithMortgage", // Enum
    "ResidenceMonthlyPayment": 8100,
    "AdditionalIncomeSources": [
      {
        "AdditionalIncomeSource": "Other", // Enum
        "Description": "Test",
        "Amount": 6900
      }
    ],
    "CoApplicantId": "A-#####", // Use only to create a new LoanApplication with an existing CoApplicant.
    "LivingSinceCurrentResidence": "2019-03-09"
  },
  "LoanParameters": {
    "SalesTax": 0,
    "SellingPrice": 17200,
    "DownPayment": 2100,
    "AmountFinanced": 15100,
    "SalesTaxIncluded": "false",
    "ContractLanguage": "English",
    "ContractState": "AK",
    "ProductOrService": "ALARM",  // Get values from “Get Products for a Dealer” endpoint.
    "CompletionDate": "2020-09-06"
  },
  "FinantialInstitutionId": "FI-0001", // Deprecated (typo), use FinancialInstitutionId
  "FinancialInstitutionId": "FI-0001",
  "AssignedUserEmailAddress": "[email protected]"
}

Get Application Status

GET https://stg.dealerallyapi.com/v1/application/status/:applicationId

This endpoint retrieves an application's status.

Path Parameters

Name
Type
Description

applicationId

string

Loan Application ID: LA######.

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

Authorization

string

Authorization token.

username

string

Username provided by Dealer Ally.

// Aqua application
{
    "ApplicationId": "LA003110",
    "Status": "Approved",
    "StatusMessages": [
        {
            "MessageType": "Condition",
            "IsMet": false,
            "Label": "Info",
            "Text": "Processing.",
            "LastModifiedDate": "2022-08-11 11:41"
        }
    ],
    "AmountFinanced": 4400.0,
    "BuyRate": "92.00%",
    "PromotionId": "PR01833",
    "PromotionName": "5.9 APR + 1% Introductory Rate Reduction",
    "PromoCode": "A59+1",
    "EstimatedMonthlyPayment": 44.0,
    "ACHStatus": "Pending",
    "SigningContractStatus": "Pending",
    "LCCStatus": "Pending",
    "RTCDate": "2022-08-19",
    "CreatedDate": "2022-08-11",
    "UpdatedDate": "2022-08-11",
    "BasicUser": {
        "FirstName": "Salli",
        "LastName": "Salles"
    }
}

// Pinnacle application
{
    "ApplicationId": "LA003108",
    "Status": "Approved",
    "Stipulations": [
        {
            "Text": "*** Conditional Approval Pending Confirmation of Homeownership by Pinnacle ***",
            "LastModifiedDate": "2022-07-28 19:36"
        }
    ],
    "AmountFinanced": 2600.0,
    "Tier": "GOLD",
    "BuyRate": "0.00",
    "CreatedDate": "2022-07-28",
    "UpdatedDate": "2022-08-11",
    "BasicUser": {
        "FirstName": "BasicUser",
        "LastName": "Test"
    },
    "LoanProgram": "18 Months SAC",
    "LoanTerm": 96,
    "APR": "7.99"
}

Get Pinnacle contract details (APRs, LoanTerms...)

GET https://stg.dealerallyapi.com/v1/application/:applicationId/get-contract-details/:amountFinanced

For a given Pinnacle Loan Application it returns valid loan programs, loan terms, APRs and the associated payment factor.

Path Parameters

Name
Type
Description

applicationId*

String

Loan Application ID: LA######.

amountFinanced

String

Amount to be financed. If it's not provided, the current financed amount in LoanParameters is used.

Headers

Name
Type
Description

x-api-key

String

This key is provided by DealerAlly.

Authorization

String

Authorization token.

username

String

Username provided by Dealer Ally.

{
    "ApprovalType": "Manual", // Or "Blanket"
    "LoanPrograms": [
        {
            "Name": "StandardFinancing",
            "Description": "Standard Financing"
        },
        {
            "Name": "90 Days SAC",
            "Description": "90 Days Same-as-Cash"
        },
        {
            "Name": "180 Days SAC",
            "Description": "180 Days Same-as-Cash"
        },
        {
            "Name": "365 Days SAC",
            "Description": "365 Days Same-as-Cash"
        },
        {
            "Name": "18 Months SAC",
            "Description": "18 Months Same-as-Cash"
        },
        {
            "Name": "24 Months SAC",
            "Description": "24 Months Same-as-Cash"
        },
        {
            "Name": "36 Months SAC",
            "Description": "36 Months Same-as-Cash"
        },
        {
            "Name": "90 Days NP",
            "Description": "90 Days No Payments"
        },
        {
            "Name": "90 Days NPNI",
            "Description": "90 Days No Payment & No Interest"
        }
    ],
    // Valid APRs
    "APRs": [
        "7.99"
    ],
    // Valid loan terms
    "LoanTerms": [
        "36",
        "60",
        "96"
    ],
    // Valid APR and loan term combinations and their payment factor
    "Promotions": [
        {
            "APR": "7.99",
            "LoanTerm": "36",
            "PaymentFactor": "0.031332",
            "EstimatedMonthlyPayment": "78.33",
            "PaymentFactorName": "36 Months - 7.99% APR"
        },
        {
            "APR": "7.99",
            "LoanTerm": "60",
            "PaymentFactor": "0.020272",
            "EstimatedMonthlyPayment": "50.68",
            "PaymentFactorName": "60 Months - 7.99% APR"
        },
        {
            "APR": "7.99",
            "LoanTerm": "96",
            "PaymentFactor": "0.014132",
            "EstimatedMonthlyPayment": "35.33",
            "PaymentFactorName": "96 Months - 7.99% APR"
        }
    ],
    "GlobalDefaultAPR": "11.99",
    "GlobalDefaultLoanTerm": "60",
    "GlobalDefaultLoanProgram": "90 Days NP",
    "DealerDefaultAPR": "9.99",
    "DealerDefaultLoanTerm": "96",
    "DealerDefaultLoanProgram": "18 Months SAC"
}

Navigating directly to a specific loan application in the DA Portal:

It is possible to create a URL that takes a user directly to a specific Loan Application in the DealerAlly Portal.

Usage: An integration partner may choose to submit loan applications and check loan statuses in their CRM or sales tool and execute contract paperwork in the DealerAlly Portal. This URL 'hack' allows them to take their users seamlessly to a specific loan in the DA Portal to do the contract paperwork.

To create that URL use the following format: https://portal.dealerallyapi.com/application/LA###### Where LA###### is the application's DealerAlly loan number.

Note: The user must be logged in to the DA Portal.

Get Promotions for an application (Only AquaFinance)

GET https://stg.dealerallyapi.com/v1/application/:applicationId/get-promotions

This endpoint retrieves valid promotion(s) for the specified Loan Application ID.

Path Parameters

Name
Type
Description

applicationId

string

Loan Application ID: LA######.

Query Parameters

Name
Type
Description

amount

number

The new AmountFinanced value.

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

Authorization

string

Authorization token.

username

string

Username provided by Dealer Ally.

[
    {
        "PaymentFactor": 0.0145,
        "Terms": 0,
        "EstimatedMonthlyPayment": 116.0,
        "ClosedEndPaymentRateId": "0",
        "Apr": 0.1199,
        "PromoCode": "11.99APR+1.45%PFR",
        "Id": "1922",
        "Name": "11.99% APR with a 1.45% Payment Factor"
    },
    {
        "PaymentFactor": 0.0145,
        "Terms": 0,
        "EstimatedMonthlyPayment": 116.0,
        "ClosedEndPaymentRateId": "0",
        "Apr": 0.1199,
        "PromoCode": "11.99APR+1.45%PFR 12MOSAC",
        "AddOnId": "1928",
        "Id": "1922",
        "Name": "11.99% APR with a 1.45% Payment Factor"
    }
]

Set Promotion for an application (Only AquaFinance) - Optional

POST https://stg.dealerallyapi.com/v1/application/:applicationId/set-promotion

This endpoint allows you to set a promotion for the specified Loan Application ID. This step is optional, the promotion can be set directly when Submitting the signing contract.

Path Parameters

Name
Type
Description

applicationId

string

Loan Application ID: LA######.

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

Authorization

string

Authorization token.

username

string

Username provided by DealerAlly.

{
    "status": "SUCCESS",
    "messages": [
        "Info: Promotion set successfully."
    ],
    "uri": "/applications/set-promotions"
}

Body:

{
	"PromotionId": 1922,
	"ClosedEndPaymentRateId": 0,
	"PaymentFactor": 0.0145,
	"PromoCode": "11.99APR+1.45%PFR",
  "Terms": 0,
  "Apr": 0.1199
}

Submit Signing Contract (Only AquaFinance)

POST https://stg.dealerallyapi.com/v1/application/signing-contract/:applicationId

This endpoint sends a request to AquaFinance to start the DocuSign signing contract flow.

Path Parameters

Name
Type
Description

applicationId

string

Loan Application ID: LA######.

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

Authorization

string

Authorization token.

username

string

Username provided by DealerAlly.

{
    "status": "SUCCESS",
    "messages": [
        "Info: Contract successfully submitted."
    ],
    "uri": "/applications/signing-contract"
}

OR

{
    "status": "AQUAFINANCE_API_ERROR",
    "messages": [
        "List of Errors"
    ],
    "uri": "/application/signing-contract"
}

OR

{
    "status": "APPLICATION_NOT_APPROVED",
    "messages": [
        "Info: This application is not Approved."
    ],
    "uri": "/application/signing-contract"
}

OR

{
    "status": "APPLICATION_NOT_FOUND",
    "messages": [
        "Info: This application is not associated to the Dealer's username provided."
    ],
    "uri": "/application/signing-contract"
}

OR

{
    "status": "USER_NOT_FOUND",
    "messages": [
        "Info: This application is not associated to the Dealer's username provided."
    ],
    "uri": "/application/signing-contract"
}

Body:

  • Optional fields: LoanParameters: SellingPrice, DownPayment, SalesTax, AmountFinanced, CompletionDate. Applicant and CoApplicant: State, City, PostalCode, Address1.

There are two types of Signatures: Email and Electronic (Sign in-person). The first one refers to Sign via email and will start a flow where each party will receive an email with a link to access the documents in DocuSign. And the Sign in-person option (Electronic) will generate a DocuSign URL that can be retrieved with the Get Application Details endpoint.

{
  "Applicant": {
    "EmailAddress": "[email protected]",
    "CellPhone": "6568751143",
    "State" : "MN",
    "City" : "Minneapolis",
    "PostalCode" : "55432",
    "Address1" : "123 Main Street"
  },
  "CoApplicant": {
    "EmailAddress": "[email protected]",
    "CellPhone": "6565551981",
    "State" : "MN",
    "City" : "Minneapolis",
    "PostalCode" : "55432",
    "Address1" : "123 Main Street"
  },
  "LoanParameters": {
    "PromotionId": "PR#####", // Optional if the promotion was previously set.
    "SellingPrice": 3000,
    "DownPayment": 0,
    "SalesTaxIncluded": false,
    "SalesTax": 0,
    "AmountFinanced": 3000,
    "CompletionDate": "2021-02-04",
    "ContractLanguage": "English" // Optional
  },
  "SignatureType": "Email" // Email or Electronic
}

Submit Signing Contract and ACH (Only AquaFinance)

POST https://stg.dealerallyapi.com/v1/application/signing-contract/:applicationId

This endpoint sends a request to AquaFinance to start the DocuSign signing contract flow, including ACH.

Path Parameters

Name
Type
Description

applicationId

string

Loan Application ID: LA######.

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

Authorization

string

Authorization token.

username

string

Username provided by DealerAlly.

{
    "status": "SUCCESS",
    "messages": [
        "Info: Contract successfully submitted."
    ],
    "uri": "/applications/signing-contract"
}

OR

{
    "status": "AQUAFINANCE_API_ERROR",
    "messages": [
        "List of Errors"
    ],
    "uri": "/application/signing-contract"
}

OR

{
    "status": "APPLICATION_NOT_APPROVED",
    "messages": [
        "Info: This application is not Approved."
    ],
    "uri": "/application/signing-contract"
}

OR

{
    "status": "APPLICATION_NOT_FOUND",
    "messages": [
        "Info: This application is not associated to the Dealer's username provided."
    ],
    "uri": "/application/signing-contract"
}

OR

{
    "status": "USER_NOT_FOUND",
    "messages": [
        "Info: This application is not associated to the Dealer's username provided."
    ],
    "uri": "/application/signing-contract"
}

Body:

  • Optional fields: LoanParameters: SellingPrice, DownPayment, SalesTax, AmountFinanced, CompletionDate. Applicant and CoApplicant: State, City, PostalCode, Address1.

There are two types of Signatures: Email and Electronic (Sign in-person). The first one refers to Sign via email and will start a flow where each party will receive an email with a link to access the documents in DocuSign. And the Sign in-person option (Electronic) will generate a DocuSign URL that can be retrieved with the Get Application Details endpoint.

{
  "Applicant": {
    "EmailAddress": "[email protected]",
    "CellPhone": "6568751143",
    "State" : "MN", // Enum
    "City" : "Minneapolis",
    "PostalCode" : "55432",
    "Address1" : "123 Main Street"
  },
  "CoApplicant": {
    "EmailAddress": "[email protected]",
    "CellPhone": "6565551981",
    "State" : "MN", // Enum
    "City" : "Minneapolis",
    "PostalCode" : "55432",
    "Address1" : "123 Main Street"
  },
  "LoanParameters": {
    "PromotionId": "PR#####", // Optional if the promotion was previously set.
    "SellingPrice": 3000,
    "DownPayment": 0,
    "SalesTaxIncluded": false,
    "SalesTax": 0,
    "AmountFinanced": 3000,
    "CompletionDate": "2021-02-04",
    "ContractLanguage": "English" // Optional
  },
  "ACHInformation": {
    "BankAccountType": "C", // Enum
    "BankRoutingNumber": 123456789,
    "BankAccountNumber" : 12334323
  },
  "SignatureType": "Email" // Email or Electronic
}

If no ACHInformation is included, this request will be treated as explained in the previous endpoint.

Submit ACH (Only AquaFinance)

POST https://stg.dealerallyapi.com/v1/application/submit-ach/:applicationId

Path Parameters

Name
Type
Description

applicationId

string

Loan Application ID: LA######.

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

Authorization

string

Authorization token.

username

string

Username provided by DealerAlly.

{
    "status": "SUCCESS",
    "messages": [
        "Info: ACH successfully submitted."
    ],
    "uri": "/applications/submit-ach"
}

OR

{
    "status": "AQUAFINANCE_API_ERROR",
    "messages": [
        "List of Errors"
    ],
    "uri": "/application/submit-ach"
}

OR

{
    "status": "APPLICATION_NOT_APPROVED",
    "messages": [
        "Info: This application is not Approved."
    ],
    "uri": "/application/submit-ach"
}

OR

{
    "status": "CONTRACT_NOT_SUBMITTED_YET",
    "messages": [
        "Info: The contract has not been submitted yet."
    ],
    "uri": "/application/submit-ach"
}

OR

{
    "status": "APPLICATION_NOT_FOUND",
    "messages": [
        "Info: This application is not associated to the Dealer's username provided."
    ],
    "uri": "/application/submit-ach"
}

OR

{
    "status": "USER_NOT_FOUND",
    "messages": [
        "Info: This application is not associated to the Dealer's username provided."
    ],
    "uri": "/application/submit-ach"
}

Body:

There are two types of Signatures: Email and Electronic (Sign in-person). The first one refers to Sign via email and will start a flow where each party will receive an email with a link to access the documents in DocuSign. And the Sign in-person option (Electronic) will generate a DocuSign URL that can be retrieved with the Get Application Details endpoint.

{
  "ACHInformation": {
    "BankAccountType": "C", //Checking: "C", Savings: "S"
    "BankRoutingNumber": 123456789,
    "BankAccountNumber" : 12334323,
    "SignatureType": "Email", // Email or Electronic
    "ContractLanguage": "English" // Optional
  }
}

Submit LCC (Only AquaFinance)

POST https://stg.dealerallyapi.com/v1/application/submit-lcc/:applicationId

Path Parameters

Name
Type
Description

applicationId

string

Loan Application ID: LA######.

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

Authorization

string

Authorization token.

username

string

Username provided by DealerAlly.

{
    "status": "SUCCESS",
    "messages": [
        "Info: ACH successfully submitted."
    ],
    "uri": "/applications/submit-lcc"
}

OR

{
    "status": "AQUAFINANCE_API_ERROR",
    "messages": [
        "List of Errors"
    ],
    "uri": "/application/submit-lcc"
}

OR

{
    "status": "APPLICATION_NOT_APPROVED",
    "messages": [
        "Info: This application is not Approved."
    ],
    "uri": "/application/submit-lcc"
}

OR

{
    "status": "CONTRACT_NOT_SUBMITTED_YET",
    "messages": [
        "Info: The contract has not been submitted yet."
    ],
    "uri": "/application/submit-lcc"
}

OR

{
    "status": "APPLICATION_NOT_FOUND",
    "messages": [
        "Info: This application is not associated to the Dealer's username provided."
    ],
    "uri": "/application/submit-lcc"
}

OR

{
    "status": "USER_NOT_FOUND",
    "messages": [
        "Info: This application is not associated to the Dealer's username provided."
    ],
    "uri": "/application/submit-lcc"
}

Body:

There are two types of Signatures: Email and Electronic (Sign in-person). The first one refers to Sign via email and will start a flow where each party will receive an email with a link to access the documents in DocuSign. And the Sign in-person option (Electronic) will generate a DocuSign URL that can be retrieved with the Get Application Details endpoint.

{
  "Address": "Asper Rd",
  "City": "Los Angeles",
  "State": "CA",
  "PostalCode": "53315",
  "SignatureType": "Email", // Email or Electronic
  "ContractLanguage": "English" // Optional
}

By sending an empty object the request will be sent to Aqua with the Applicant's address previously submitted.

Resend documents (Only AquaFinance)

POST https://stg.dealerallyapi.com/v1/application/:applicationId/resend-documents

Resends AquaFinance contract.

Path Parameters

Name
Type
Description

applicationId*

String

Loan Application ID: LA######.

Query Parameters

Name
Type
Description

documentType*

String

Contract to resend, can be one of the following: FULL, LCC, ACH.

Headers

Name
Type
Description

x-api-key*

String

This key is provided by DealerAlly.

Authorization*

String

Authorization token.

username*

String

Username provided by DealerAlly.

Complete Contract (Only Pinnacle)

POST https://stg.dealerallyapi.com/v1/application/contract-completion/:applicationId

This endpoint submits a request to Pinnacle to create the contract paperwork for a specified Loan Application and to have that paperwork emailed to all parties for e-signing.

Path Parameters

Name
Type
Description

applicationId

string

Loan Application ID: LA######.

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

Authorization

string

Authorization token.

username

string

Username provided by DealerAlly.

{
    "status": "SUCCESS",
    "messages": ["Info: Documents Generated"],
    "uri": "/application/contract-completion"
}

Body:

  • LoanApplicationDate must be in YYYY-MM-dd format.

  • BankAccountNumber: must not be empty.

  • BankRoutingNumber: BankRoutingNumber must have 9 digits.

  • BankAccountType: Valid values are ‘C’ and ‘S’ for Checking or Savings.

  • CompletionDate: must >= today.

  • DownPayment: must not be null.

  • ManufacturerGoodsServiceSold: must not be empty.

  • SaleAmount: must not be null.

  • ProductOrService: must not be empty.

  • SerialNum

  • Loan Application must be in "Approved" or "SignReady" state.

  • For a given Pinnacle Loan Application, get valid loan programs, loan (repayment) terms, APRs, and associated payment factors from the following endpoint: Get Pinnacle contract details (APRs, LoanTerms...) https://docs.dealerallyapi.com/endpoints#get-pinnacle-contract-details-aprs-loanterms

{
  "ManufacturerGoodsServiceSold": "QolSys",
  "ProductOrService": "Security System",
  "SerialNumberGoodsServiceSold": "100XX02",
  "SaleAmount": 6000,
  "DownPayment": 600,
  "LoanProgram": "365 Days SAC",
  "CompletionDate": "2020-06-21",
  "BankAccountType": "C",
  "BankRoutingNumber": "123456789",
  "BankAccountNumber": "43565765",
  "APR": 9.99,
  "RepaymentTerms": "36",
  "LoanApplicationDate": "2020-06-13"
}

Resend contract (Only Pinnacle)

GET https://stg.dealerallyapi.com/v1/application/contract-completion/:applicationId/resend

Path Parameters

Name
Type
Description

applicationId*

String

Loan Application ID: LA######.

Headers

Name
Type
Description

x-api-key*

String

This key is provided by DealerAlly.

Authorization*

String

Authorization token.

username*

String

Username provided by DealerAlly.

Get Paperwork Status

GET https://stg.dealerallyapi.com/v1/application/:applicationId/paperwork-signed-status/:type

This endpoint retrieves the status of a submitted contract.

Path Parameters

Name
Type
Description

applicationId

string

Loan Application ID: LA######

type

string

Status type: FULL, ACH or LCC.

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

Authorization

string

Authorization token.

username

string

Username provided by DealerAlly.

[
    {
        "EmailAddress": "[email protected]",
        "DateSent": "2021-02-05 14:08",
        "SigneeType": "Applicant",
        "DateSigned": "2021-02-05 14:35"
    },
    {
        "EmailAddress": "[email protected]",
        "DateSent": "2021-02-05 14:35",
        "SigneeType": "Dealer",
        "DateSigned": "2021-02-05 14:36"
    }
]

Get Applications by Dealer

GET https://stg.dealerallyapi.com/v1/application/get-dealer-applications

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

Authorization

string

Authorization token.

username

string

Username provided by DealerAlly.

[
    ...
    {
        "CreationDate": "2020-08-30 21:25",
        "LastModifiedDate": "2020-08-30 21:33",
        "LoanApplicationStatus": "Denied",
        "Tier": "NONE",
        "ApplicantId": "A-00077",
        "ApplicationId": "LA000070",
        "FinancialInstitution": "AquaFinance",
        "FinancialInstitutionId": "FI-0002",
        "FIApplicationNumber": "20107",
        "DealerName": "DEALER ALLY - TEST FILE",
        "UserFullName": "George Orwell",
        "ApplicantFullName": "Edith Clarke"
    },
    {
        "CreationDate": "2020-08-30 20:04",
        "LastModifiedDate": "2020-08-30 21:34",
        "IsStubApplication": false,
        "LoanApplicationStatus": "Pending",
        "Tier": "GOLD",
        "ApplicantId": "A-00075",
        "ApplicationId": "LA000069",
        "FinancialInstitution": "Pinnacle Finance",
        "FinancialInstitutionId": "FI-0002",
        "FIApplicationNumber": "20105",
        "DealerName": "DEALER ALLY - TEST FILE",
        "UserFullName": "Mark Twain",
        "ApplicantFullName": "Janese Swanson"
    }
    ...
]


OR

{
    "status": "USER_NOT_FOUND",
    "messages": [
        "Info: User not found in ORG."
    ],
    "uri": "/applications/get-applications"
}

Get Application details

GET https://stg.dealerallyapi.com/v1/application/:applicationId/get-details

This endpoint retrieves the complete details for a Loan Application.

Path Parameters

Name
Type
Description

applicationId

string

Loan Application ID: LA######.

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

Authorization

string

Authorization token.

username

string

Username provided by Dealer Ally.

{
    "Applicant": {
        "HireDate": "1998-12-31",
        "DateOfBirth": "1969-12-31",
        "LivingSinceCurrentResidence": "1999-12-31",
        "State": "MN",
        "FirstName": "APITest",
        "LastName": "TestFour",
        "Address1": "123 Main St",
        "PostalCode": "55123",
        "CellPhone": "6513351212",
        "HomePhone": "6513351212",
        "PayFrequency": "M",
        "City": "St. Paul",
        "Occupation": "Manager",
        "BusinessPhone": "6515551212",
        "EmployerState": "MN",
        "ResidenceType": "OwnWithMortgage",
        "NetIncome": 5000.0,
        "HasCoApplicant": false,
        "IsIssueStatePresent": false,
        "SocialSecurityNumber": "987654321",
        "GrossMonthlyIncome": 5000.0,
        // Deprecated. Use IdentificationType and
        // IdentificationNumber instead
        "DriversLicense": "M98765456789",
        // See IdentificationTypeEnum
        "IdentificationType": "UnitedStatesPassport",
        "IdentificationNumber": "543765123",
        "ExpirationDateUnavailable": false,
        "IdentificationExpirationDate": "2024-12-01",
        "IsIssueDatePresent": true,
        "IdentificationIssuedDate": "2019-12-01",
        "IsIssueStatePresent": true,
        "IdentificationIssueState": "MN",
        "CurrentEmployer": "Amazon",
        "PostalCodePlus4": "0000",
        "EmploymentType": "Employed",
        "IsIssueDatePresent": false,
        "EmploymentTermType": "M",
        "ResidenceMonthlyPayment": 1000.0,
        "DriversLicenseState": "MN",
        "EmailAddress": "[email protected]"
    },
    "CoApplicant": {
        "HireDate": "2009-12-31",
        "DateOfBirth": "1968-12-31",
        "State": "MN",
        "FirstName": "APITestB",
        "LastName": "TestB",
        "Address1": "123 Main St",
        "PostalCode": "55123",
        "CellPhone": "6513351212",
        "City": "St. Paul",
        "Occupation": "Supervisor",
        "BusinessPhone": "6513351212",
        "EmployerState": "MN",
        "NetIncome": 4000.0,
        "HasCoApplicant": false,
        "IsIssueStatePresent": false,
        "SocialSecurityNumber": "123456789",
        "GrossMonthlyIncome": 4000.0,
        // Deprecated. Use IdentificationType and
        // IdentificationNumber instead
        "DriversLicense": "M8756789",
        // See IdentificationTypeEnum
        "IdentificationType": "UnitedStatesPassport",
        "IdentificationNumber": "743765123",
        "ExpirationDateUnavailable": false,
        "IdentificationExpirationDate": "2024-11-08",
        "IsIssueDatePresent": true,
        "IdentificationIssuedDate": "2019-12-08",
        "IsIssueStatePresent": true,
        "IdentificationIssueState": "MN",
        "CurrentEmployer": "Google",
        "PostalCodePlus4": "0000",
        "EmploymentType": "Employed",
        "IsIssueDatePresent": false,
        "EmploymentTermType": "M",
        "DriversLicenseState": "MN",
        "EmailAddress": "[email protected]"
    },
    "LoanParameters": {
        "LoanDate": "2020-06-24",
        "SaleAmount": 2600.0,
        "DownPayment": 100.0,
        "HasTradeIn": false,
        "AmountFinanced": 2500.0,
        "SalesTaxIncluded": false,
        "CompletionDate": "2022-02-20",
        // The following fields are only returned 
        // for Pinnacle Loan Aplications
        // that have submitted "Complete Contract"
        "ProductOrService": "Security System",
        "RepaymentTerms": "96",
        "LoanProgram": "90 Days SAC",
        "APR": "11.99",
        "LoanDate": "2022-02-02",
        "FirstPaymentDate": "2022-03-04",
        "ManufacturerGoodsServiceSold": "Electric systems",
        "SerialNumberGoodsServiceSold": "0",
        "PinnaclePaymentFactor": "0.016247",
        // See "BankAccountType" enum for all the values
        "BankAccountType": "C",
        "BankRoutingNumber": "111111111",
        "BankAccountNumber": "222222"
    },
    "ContractApprovalType": "Manual", // Manual or Blanket
    "ContractCompletionSentDate": "2020-06-26",
    "ContractCompletionSignedDate": "2020-06-26",
    "DealerNumber": "007550.999",
    "FIApplicationId": "19689",
    "ApplicationId": "LA000###",
    "IsStubApplication": false,
    "CreationDate": "2020-06-24 12:20",
    "ContractCompletionStatus": "Empty",
    "Tier": "SILVER",
    "SigningContractESignUrl": "https://demo.docusign.net/b1f4-bffb647bdef8...",
    "ACHESignUrl": "https://demo.docusign.net/ImFsZyI6IlJTMjU2Iiwi...",
    "LCCESignUrl": "https://demo.docusign.net/JcIixcIkZha2VRdWVyeVN...",
    // Aqua only
    "Promotion": { 
        "Id": "1922",
        "PromotionId": "PR01460",
        "PromotionName": "11.99% APR with a 1.45% Payment Factor",
        "PaymentFactor": 0.0145,
        "Apr": 0.1199,
        "Terms": 0.0,
        "PromoCode": "11.99APR+1.45%PFR",
        "EstimatedMonthlyPayment": 51.0,
        "ClosedEndPaymentRateId": "0"
    },
    "RTCDate": "2022-01-13", // Aqua only
    "BuyRate": "95.00%", // Aqua only,
    "BidPercent": "100.00", // Pinnacle only,
    "FinancialInstitution": "Pinnacle Finance",
    "FinancialInstitutionId": "FI-0002",
    "AssignedUserEmailAddress": "[email protected]"
}


OR

{
    "status": "APPLICATION_NOT_FOUND",
    "messages": [
        "Info: This application is not associated to the Dealer's username provided."
    ],
    "uri": "/application/get-details"
}


OR

{
    "status": "USER_NOT_FOUND",
    "messages": [
        "Info: User not found in ORG."
    ],
    "uri": "/application/get-details"
}

Get Application Documents

GET https://stg.dealerallyapi.com/v1/application/:applicationId/documents

This endpoint retrieves all documents from a specific Loan Application.

Path Parameters

Name
Type
Description

applicationId

string

Loan Application ID: LA######.

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

Authorization

string

Authorization token.

[
    {
        "CreationDate": "2020-06-26 09:25",
        "Id": "LAD000117",
        "Type": "Monitoring Agreement",
        "Filename": "aws_logo_smile_1200x630-MA.png"
    },
    {
        "CreationDate": "2020-01-20 15:23",
        "Id": "LAD000004",
        "Type": "Monitoring Agreement",
        "Filename": "OtherDocument.pdf"
    }
]


OR

{
    "status": "APPLICATION_NOT_FOUND",
    "messages": [
        "Info: There's no application associated to this DealerId with ID: LA000549d."
    ],
    "uri": "/applications/get-promotions"
}

Upload Document to an Application

PUT https://stg.dealerallyapi.com/v1/application/:applicationId/documents

This endpoint allows you to upload a document to DealerAlly system.

Path Parameters

Name
Type
Description

applicationId

string

Loan Application ID: LA######.

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

Authorization

string

Authorization token.

Request Body

Name
Type
Description

document-type

string

DocumentType Enum value.

file

object

The actual file.

{
    "status": "SUCCESS",
    "messages": [
        "Info: Document uploaded with success in application: LA000220."
    ],
    "uri": "/application/documents"
}


OR

{
    "status": "APPLICATION_NOT_FOUND",
    "messages": [
        "Info: There's no application with ID: LA0004583."
    ],
    "uri": "/application/documents"
}


OR

{
    "status": "DOCUMENT_TYPE_NOT_ACCEPTED",
    "messages": [
        "Info: Only these extensions are accepted: .pdf and image/*."
    ],
    "uri": "/application/documents"
}


OR

{
    "status": "FILESIZE_TOO_BIG",
    "messages": [
        "Info: You can only upload files up to 2MB"
    ],
    "uri": "/application/documents"
}

Download document from an Application

GET https://stg.dealerallyapi.com/v1/application/:applicationId/documents/:fileId

This endpoint allows you to download a document from DealerAlly system.

Path Parameters

Name
Type
Description

applicationId

string

Loan Application ID: LA######.

fileId

string

File ID.

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

Authorization

string

Authorization token.

The body response is the actual file.

OR

{
    "status": "APPLICATION_NOT_FOUND",
    "messages": [
        "Info: There's no application with ID: LA00022033."
    ],
    "uri": "/application/documents"
}


OR

{
    "status": "DOCUMENT_NOT_FOUND",
    "messages": [
        "Info: There's no document with that ID for the Application: LA000549."
    ],
    "uri": "/application/documents"
}

Get Products for a Dealer

GET https://stg.dealerallyapi.com/v1/dealer/get-products

This endpoint retrieves active products for a Dealer.

Headers

Name
Type
Description

FinancialInstitution

string

FI-0001 (AquaFinance) or FI-0002 (Pinnacle).

x-api-key

string

This key is provided by DealerAlly.

Authorization

string

Authorization token.

username

string

Username provided by DealerAlly.

[
  {
    "ProductOrService": "MARINE"
  },
  {
    "ProductOrService": "ALARM"
  },
  {
    "ProductOrService": "SMARTHOME"
  }
]

Get Financial Institutions for a Dealer

GET https://stg.dealerallyapi.com/v1/dealer/get-financial-institutions

This endpoint retrieves Financial Institutions which a Dealer has access to.

Headers

Name
Type
Description

x-api-key

string

This key is provided by DealerAlly.

Authorization

string

Authorization token.

DealerId

string

Assigned Dealer Id.

[
    {
        "Name": "Aqua Finance",
        "Id": "FI-0001",
        "ParametersProperlySet": true
    },
    {
        "Name": "Pinnacle Finance",
        "Id": "FI-0002",
        "ParametersProperlySet": true
    }
]


OR

{
    "status": "DEALER_NOT_FOUND",
    "messages": [
        "Info: There's no dealers associated."
    ],
    "uri": "/dealer/get-financial-institutions"
}
PreviousIntroductionNextEnums

Last updated