...
1 Qualification
1 pre property application
5 pre property product results or PQRs
1 regular credit application
5 regular credit product results or PQRS
Using the APIs:
Processes
The process structure points down, allowing you access to all application processes from the qualification process
Applications
The application structure, on the other hand, points up. The benefit of this is that each PQR, scorecard result, legal contact, legal site and application has a direct reference to its parent allowing for simple access going up and in turn allowing the parent to easily see all of its children. This is the key to both metrics development for qualification and the ability to have concurrent applications.
Flow of Endpoints
In order to get the information needed for the qualification page you should make the following calls (see below for information on the responses):
- GET /api/v1/qualification/?solarsite_id={uuid}
- GET /api/v1/qualification/{uuid}/applications/
- GET /api/v1/qualification/{uuid}/product_results/
- GET /api/v1/qualification/{uuid}/legal_info/
- GET /api/v1/qualification/{uuid}/comment_feed/
- GET /api/v1/qualification_process/{uuid}/processes/
These 6 calls should give all of the information needed for the entire page. The additional calls in the next section are supplemental action calls that should cover all of the actions that can be taken from the qualification page.
URLs, Bodies And Responses, oh my!
These are the set of endpoints relevant to our Qualification Page:
Get Qualifications
- GET /api/v1/qualification/?solarsite_id={uuid}
- Response:
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"uuid": "d447d4a5-ef62-44ed-961d-a0cd3a524536",
"solarsite": "c007c274-5342-4d8a-9ed8-e285360e42e7",
"qualification_process": "a58b2b60-5b7a-4495-af06-01fb44870ecb",
"process_name": "Sunlight Financial - SolarCity",
"date_updated": "2017-10-20T07:03:01.161687Z"
}
]
}
Get Applications
- GET /api/v1/qualification/{uuid}/applications/
- Response:
{
"regular": {
"credit": {
"uuid": "5dace4ea-30be-460a-884d-fb9ae9c12f58",
"status": "NOSTART",
"is_prequal": false,
"access_token": "fdddc0aba81f4be5b770490b150c6e41",
"application_mode": null,
"date_initiated": null,
"date_submitted": null,
"application_process": "cf100817-9d3a-4ec0-9164-39b2108e63fe",
"qualification": "2de0c1cc-2ffa-4ae5-ba8f-a19d74d7dfe5",
"application_url": "https://www.greenskycredit.com/consumer",
"application_stage": "regular",
"application_category": "CREDIT",
"date_updated": "2017-11-14T18:14:03.547149Z",
"external_ids": []
},
"property": null,
"title": null
},
"pre": {
"credit": null,
"property": null,
"title": null
}
}
Get Product Results
- GET /api/v1/qualification/{uuid}/product_results/
- Response:
[
{
"product_name": "Sighten Loan",
"uuid": "0203720f-6519-4bc5-8289-8058a9007124",
"results": {
"pre": {
"title": null,
"property": {
"uuid": "d981d3a5-b3bb-4816-8318-8df6a14614c0",
"status": "CONDITIONAL",
"ineligible": false,
"contract_term": "20",
"apr": 2.99,
"min_amount_approved": null,
"max_amount_approved": 30000,
"expiration_date": "2018-03-05T10:21:57.095623Z",
"product": "0203720f-6519-4bc5-8289-8058a9007124",
"product_name": "Sighten Loan",
"application_category": "PROPERTY",
"application_stage": "pre",
"credit_application": null,
"title_application": null,
"property_application": "ab899c79-5497-4661-9045-0bc1839fcac7",
"quote": null,
"date_updated": "2017-05-10T07:38:43.092709Z"
},
"credit": null
},
"regular": {
"title": null,
"property": null,
"credit": {
"uuid": "147329b0-0010-4a33-8c61-cc3b32a52b33",
"status": "APPROVED",
"ineligible": false,
"contract_term": "20",
"apr": 2.99,
"min_amount_approved": null,
"max_amount_approved": 25000,
"expiration_date": "2018-03-05T10:21:57.095623Z",
"product": "0203720f-6519-4bc5-8289-8058a9007124",
"product_name": "Sighten Loan",
"category": "CREDIT",
"credit_application": "2c1de646-8d71-420d-a6dc-25dc66d26c57",
"title_application": null,
"property_application": null,
"quote": null,
"date_updated": "2017-05-10T07:38:43.092709Z"
}
}
}
}
]
Get Legal Info
- GET /api/v1/qualification/{uuid}/legal_info/
- Response:
{
"can_add_legal_contacts": false,
"legal_sites": {
"preferred": [
{
"uuid": "aa33b218-033b-4424-aa77-93d99bfce21f",
"street_address": "41515 Monterey Ave",
"city_name": "Rancho Mirage",
"state_abbreviation": "CA",
"zipcode": "92270",
"county_name": "Riverside",
"trust_name": null,
"property_type": null,
"property_type_other_value": null,
"vesting_code": null,
"vesting_code_other_value": null,
"user_permissions": [
"R"
],
"credit_application": null,
"title_application": null,
"property_application": "2cce9602-55b8-4955-9d87-bd40e966773b",
"application_category": "PROPERTY"
}
],
"all_legal_sites": [
{
"uuid": "aa33b218-033b-4424-aa77-93d99bfce21f",
"street_address": "41515 Monterey Ave",
"city_name": "Rancho Mirage",
"state_abbreviation": "CA",
"zipcode": "92270",
"county_name": "Riverside",
"trust_name": null,
"property_type": null,
"property_type_other_value": null,
"vesting_code": null,
"vesting_code_other_value": null,
"user_permissions": [
"R"
],
"credit_application": null,
"title_application": null,
"property_application": "2cce9602-55b8-4955-9d87-bd40e966773b",
"application_category": "PROPERTY"
}
]
},
"legal_contacts": {
"all_legal_contacts": [
{
"uuid": "f4a2dff4-d320-4936-9818-d736213e6974",
"first_name": "Sighten",
"last_name": "Test",
"email": "tmm2@yopmail.com",
"phone_number": null,
"applicant_type": "PRIMARY",
"is_trustee": null,
"user_permissions": [
"R"
],
"credit_application": null,
"title_application": null,
"property_application": "2cce9602-55b8-4955-9d87-bd40e966773b",
"application_category": "PROPERTY"
}
],
"preferred": [
{
"uuid": "f4a2dff4-d320-4936-9818-d736213e6974",
"first_name": "Sighten",
"last_name": "Test",
"email": "tmm2@yopmail.com",
"phone_number": null,
"applicant_type": "PRIMARY",
"is_trustee": null,
"user_permissions": [
"R"
],
"credit_application": null,
"title_application": null,
"property_application": "2cce9602-55b8-4955-9d87-bd40e966773b",
"application_category": "PROPERTY"
}
]
}
}
Get Processes
- GET /api/v1/qualification_process/{uuid}/processes/
- Response:
{
"name": "PACE Funding Qualification Process",
"description": "Integration Qual Process",
"uuid": "9236e84a-9143-494d-b3b3-27d1f8ffc63e",
"processes": {
"regular": {
"credit": {
"uuid": "c4e4397b-9038-4e37-acb8-cafef7074488",
"required_obj": "QUOTE",
"name": "PACE Funding Credit Application",
"description": "",
"handler": "8f2d2245-a001-4797-8d96-63027a65a200",
"is_prequal": false,
"auto_initiate": false,
"auto_submit": false,
"max_contacts": 1,
"send_application_email": true,
"in_person_application": false,
"sighten_hosted_application": false,
"external_link": null,
"qa_external_link": null,
"email_apply_instructions": "By clicking submit, you will email a link for a customer credit application to the selected contact.",
"in_person_apply_instructions": "By clicking submit, you will open an external link to a customer credit application for the selected contact.",
"is_financier_branded": true,
"check_can_generate_docs": true,
"allows_financier_update": true,
"allows_contractor_update": false,
"allows_developer_update": false,
"block_cancellation": true,
"application_category": "CREDIT",
"application_stage": "regular"
},
"property": null,
"title": null
},
"pre": {
"credit": null,
"property": {
"uuid": "3caf0820-08b4-49b0-877b-c1ca2c16064b",
"required_obj": "CONTACT",
"name": "PACE Funding Pre-Qualification Definition",
"description": "",
"handler": "5d975bbc-0d73-4705-9aee-7836c31c786e",
"is_prequal": true,
"auto_initiate": true,
"auto_submit": true,
"max_contacts": 0,
"send_application_email": false,
"in_person_application": false,
"sighten_hosted_application": false,
"external_link": null,
"qa_external_link": null,
"email_apply_instructions": "By clicking submit, you will email a link for a property pull to the selected contact.",
"in_person_apply_instructions": "By clicking submit, you will open an external link to pull property for the selected contact.",
"is_financier_branded": true,
"check_can_generate_docs": false,
"allows_financier_update": true,
"allows_contractor_update": false,
"allows_developer_update": false,
"block_cancellation": true,
"application_category": "TITLE",
"application_stage": "pre"
},
"title": null
}
}
}
Get Comment Feed
- GET /api/v1/qualification/{uuid}/comment_feed/
- Response:
[
{
"uuid": "a0f1030f-ed8d-4f20-9af7-1b9ea28cac9c",
"comment": "Sighten Admin cancelled property application.",
"thread": null,
"commentor": "sightenbot@sighten.io",
"commentor_first_name": "Sighten",
"commentor_last_name": "Bot",
"timestamp": "2017-11-15T05:57:13.841790Z"
},
{
"uuid": "5dd7fefd-fd49-44f2-be22-fee7d77846ab",
"comment": "Sighten Admin initiated property application.",
"thread": null,
"commentor": "sightenbot@sighten.io",
"commentor_first_name": "Sighten",
"commentor_last_name": "Bot",
"timestamp": "2017-11-15T05:57:13.853883Z"
}
]
Add Comment
- POST /api/v1/qualification/{uuid}/add_comment/
- Body: {‘comment’: ‘comment text here’}
- Response:
{
"uuid": "b8ba9075-919a-4098-bba3-889da828f1d0",
"comment": "hello world",
"thread": null,
"commentor": "admin@sighten.io",
"commentor_first_name": "Admin",
"commentor_last_name": "",
"timestamp": "2017-11-15T05:37:27.973766Z"
}
Set Application Mode
- PUT to one of:
- /api/v1/credit_application/{uuid}/
- /api/v1/title_application/{uuid}/
- /api/v1/property_application/{uuid}/
- Body (one of):
- {“application_mode”: “EMAIL”}
- {“application_mode”: “INPERSON”}
- Response:
{
"uuid": "5dace4ea-30be-460a-884d-fb9ae9c12f58",
"status": null,
"is_prequal": false,
"access_token": "fdddc0aba81f4be5b770490b150c6e41",
"application_mode": “EMAIL”,
"date_initiated": null,
"date_submitted": null,
"application_process": "cf100817-9d3a-4ec0-9164-39b2108e63fe",
"qualification": "2de0c1cc-2ffa-4ae5-ba8f-a19d74d7dfe5",
"application_url": "https://www.greenskycredit.com/consumer",
"application_stage": "regular",
"application_category": "CREDIT",
"date_updated": "2017-11-15T05:40:58.247983Z",
"external_ids": []
}
Initiate Credit
- POST /api/v1/credit_application/{uuid}/initiate/
- Body (optional): {‘quote_id’: ‘selected quote uuid’}
- Response:
{
"uuid": "5dace4ea-30be-460a-884d-fb9ae9c12f58",
"status": "INITIATED",
"is_prequal": false,
"access_token": "fdddc0aba81f4be5b770490b150c6e41",
"application_mode": “EMAIL”,
"date_initiated": "2017-11-15T05:40:58.246616Z",
"date_submitted": null,
"application_process": "cf100817-9d3a-4ec0-9164-39b2108e63fe",
"qualification": "2de0c1cc-2ffa-4ae5-ba8f-a19d74d7dfe5",
"application_url": "https://www.greenskycredit.com/consumer",
"application_stage": "regular",
"application_category": "CREDIT",
"date_updated": "2017-11-15T05:40:58.247983Z",
"external_ids": []
}
Initiate Property
- POST /api/v1/property_application/{uuid}/initiate/
- Body (optional): {‘quote_id’: ‘selected quote uuid’}
- Response:
{
"uuid": "5dace4ea-30be-460a-884d-fb9ae9c12f58",
"status": "INITIATED",
"is_prequal": true,
"access_token": "fdddc0aba81f4be5b770490b150c6e41",
"application_mode": null,
"date_initiated": "2017-11-15T05:40:58.246616Z",
"date_submitted": “2017-11-15T05:41:03.246616Z”,
"application_process": "cf100817-9d3a-4ec0-9164-39b2108e63fe",
"qualification": "2de0c1cc-2ffa-4ae5-ba8f-a19d74d7dfe5",
"application_url": null,
"application_stage": "pre",
"application_category": "PROPERTY",
"date_updated": "2017-11-15T05:41:03.247983Z",
"external_ids": []
}
Initiate Title
- POST /api/v1/title_application/{uuid}/initiate/
- Body (optional): {‘quote_id’: ‘selected quote uuid’}
- Response:
{
"uuid": "5dace4ea-30be-460a-884d-fb9ae9c12f58",
"status": "INITIATED",
"is_prequal": true,
"access_token": "fdddc0aba81f4be5b770490b150c6e41",
"application_mode": null,
"date_initiated": "2017-11-15T05:40:58.246616Z",
"date_submitted": “2017-11-15T05:41:03.246616Z”,
"application_process": "cf100817-9d3a-4ec0-9164-39b2108e63fe",
"qualification": "2de0c1cc-2ffa-4ae5-ba8f-a19d74d7dfe5",
"application_url": null,
"application_stage": "pre",
"application_category": "TITLE",
"date_updated": "2017-11-15T05:40:58.247983Z",
"external_ids": []
}
Cancel Credit
- POST /api/v1/credit_application/{uuid}/cancel/
- Response:
{
"uuid": "c253c5d3-cbe1-48b8-80a3-d773465b5a0e",
"status": "NOSTART",
"is_prequal": false,
"access_token": "66d6d79bab7e4183946017d9ca2df72f",
"application_mode": null,
"date_initiated": null,
"date_submitted": null,
"application_process": "cf100817-9d3a-4ec0-9164-39b2108e63fe",
"qualification": "2de0c1cc-2ffa-4ae5-ba8f-a19d74d7dfe5",
"application_url": "https://www.greenskycredit.com/consumer",
"application_stage": "regular",
"application_category": "CREDIT",
"date_updated": "2017-11-15T05:47:47.591842Z",
"external_ids": []
}
Cancel Property
- POST /api/v1/property_application/{uuid}/cancel/
- Response:
{
"uuid": "c253c5d3-cbe1-48b8-80a3-d773465b5a0e",
"status": "NOSTART",
"is_prequal": true,
"access_token": "66d6d79bab7e4183946017d9ca2df72f",
"application_mode": null,
"date_initiated": null,
"date_submitted": null,
"application_process": "cf100817-9d3a-4ec0-9164-39b2108e63fe",
"qualification": "2de0c1cc-2ffa-4ae5-ba8f-a19d74d7dfe5",
"application_url": null,
"application_stage": "regular",
"application_category": "PROPERTY",
"date_updated": "2017-11-15T05:47:47.591842Z",
"external_ids": []
}
Cancel Title
- POST /api/v1/title_application/{uuid}/cancel/
- Response:
{
"uuid": "c253c5d3-cbe1-48b8-80a3-d773465b5a0e",
"status": "NOSTART",
"is_prequal": true,
"access_token": "66d6d79bab7e4183946017d9ca2df72f",
"application_mode": null,
"date_initiated": null,
"date_submitted": null,
"application_process": "cf100817-9d3a-4ec0-9164-39b2108e63fe",
"qualification": "2de0c1cc-2ffa-4ae5-ba8f-a19d74d7dfe5",
"application_url": null,
"application_stage": "regular",
"application_category": "TITLE",
"date_updated": "2017-11-15T05:47:47.591842Z",
"external_ids": []
}
Resend Email Credit
- POST /api/v1/credit_application/{uuid}/resend_email/
- Response:
{
"uuid": "13613f14-e54d-4f8e-8eb4-dcbf49b56b62",
"status": "INITIATED",
"is_prequal": false,
"access_token": "72dc0ea80ef74bef80498cf801b7aeb7",
"application_mode": "EMAIL",
"date_initiated": "2017-11-15T06:36:23.995260Z",
"date_submitted": null,
"application_process": "6d159695-99ed-46f0-be0f-c59845dde610",
"qualification": "46f9694d-8963-4504-9fd3-2e4760f01e6b",
"application_url": "https://sandbox2.sighten.io/solar/pipeline/credit_auth/?token=72dc0ea80ef74bef80498cf801b7aeb7",
"application_stage": "regular",
"application_category": "CREDIT",
"date_updated": "2017-11-15T06:36:23.995417Z",
"external_ids": []
}
Resend Email Property
- POST /api/v1/property_application/{uuid}/resend_email/
- Response:
{
"uuid": "13613f14-e54d-4f8e-8eb4-dcbf49b56b62",
"status": "INITIATED",
"is_prequal": true,
"access_token": "72dc0ea80ef74bef80498cf801b7aeb7",
"application_mode": "EMAIL",
"date_initiated": "2017-11-15T06:36:23.995260Z",
"date_submitted": null,
"application_process": "6d159695-99ed-46f0-be0f-c59845dde610",
"qualification": "46f9694d-8963-4504-9fd3-2e4760f01e6b",
"application_url": "https://sandbox2.sighten.io/solar/pipeline/credit_auth/?token=72dc0ea80ef74bef80498cf801b7aeb7",
"application_stage": “pre",
"application_category": "PROPERTY",
"date_updated": "2017-11-15T06:36:23.995417Z",
"external_ids": []
}
Resend Email Title
- POST /api/v1/title_application/{uuid}/resend_email/
- Response:
{
"uuid": "13613f14-e54d-4f8e-8eb4-dcbf49b56b62",
"status": "INITIATED",
"is_prequal": true,
"access_token": "72dc0ea80ef74bef80498cf801b7aeb7",
"application_mode": "EMAIL",
"date_initiated": "2017-11-15T06:36:23.995260Z",
"date_submitted": null,
"application_process": "6d159695-99ed-46f0-be0f-c59845dde610",
"qualification": "46f9694d-8963-4504-9fd3-2e4760f01e6b",
"application_url": "https://sandbox2.sighten.io/solar/pipeline/credit_auth/?token=72dc0ea80ef74bef80498cf801b7aeb7",
"application_stage": "pre",
"application_category": "TITLE",
"date_updated": "2017-11-15T06:36:23.995417Z",
"external_ids": []
}
Update Product Qualification Result
- PUT /api/v1/product_qualification_result/{uuid}/
- Body (any of and combinations of):
- {“status”: “APPROVED/MANUAL/FAIL/CONDITIONAL”}
- {“max_amount_approved”: >=0}
- {“expiration_date”: “2017-11-15”}
- Response:
{
"uuid": "14460ae2-b7fc-4f1d-a417-633232c87eb3",
"status": "APPROVED",
"ineligible": true,
"contract_term": null,
"apr": null,
"min_amount_approved": null,
"max_amount_approved": null,
"expiration_date": null,
"product": "9b95168b-be6d-4fdd-b195-82dcaffbeb3e",
"product_name": "enVision E 20 6.99%",
"category": "CREDIT",
"credit_application": "54b617ac-736b-46c6-a27d-a120c5df8254",
"title_application": null,
"property_application": null,
"quote": null,
"date_updated": "2017-11-15T08:51:41.149133Z"
}
Add Legal Contact
- POST /api/v1/legal_contact/{uuid}/
- Body must include all of the followingone of:
- {“credit_application_id”: “uuid”}
- {“title_application_id”: “uuid”}
- {“property_application_id”: “uuid”}
- Body:
{
"first_name":"zach",
"last_name":"testing",
"email":"zach@sighten.io",
"phone_number":"2072327941",
"applicant_type":"PRIMARY",
"credit_application_id":"78de5b35-9140-42b4-94e2-d48c52c163a5"
"title_application_id":null
"property_application_id":null
}
- Response:
{
"uuid": "76940949-c0da-4a90-b0fb-726023fb1c6a",
"first_name": "zach",
"last_name": "test",
"email": "test@live.com",
"phone_number": "2078382601",
"applicant_type": "PRIMARY",
"is_trustee": null,
"user_permissions": [
"R"
],
"Credit_application": 78de5b35-9140-42b4-94e2-d48c52c163a5,
"title_application": null,
"property_application": null,
"application_category": “CREDIT”,
"application_stage": “regular”
}
Update Legal Contact:
- PUT /api/v1/legal_contact/{uuid}
- Body (any combination of):
- {"first_name": "zach”}
- {"last_name": "test"}
- {"email": "test@live.com"}
- {"phone_number": "2078382601"}
- {"applicant_type": "PRIMARY”}
- {is_trustee": null}
- Response:
{
"uuid": "76940949-c0da-4a90-b0fb-726023fb1c6a",
"first_name": "zach",
"last_name": "test",
"email": "test@live.com",
"phone_number": "2078382601",
"applicant_type": "PRIMARY",
"is_trustee": null,
"user_permissions": [
"R"
],
"credit_application": 78de5b35-9140-42b4-94e2-d48c52c163a5,
"title_application": null,
"property_application": null,
"application_category": “CREDIT”,
"application_stage": “regular”
}
Delete Legal Contact
- DELETE /api/v1/legal_contact/{uuid}/
Add Legal Site
- POST /api/v1/legal_address/
- Body must include all the following fields: (set to null if not in use)one of:
- {“credit_application_id”: “uuid”}
- {“title_application_id”: “uuid”}
- {“property_application_id”: “uuid”}
- Body:
{
"street_address":"2324 Calcite St",
"city_name":"Loveland",
"state_abbreviation":"CO",
"zipcode":"80537",
"property_type":"APARTMENT",
"credit_application_id":"cdea89c3-c294-43fd-bfb6-6d53663b7888"
}
- Response:
{
"uuid":"acca1148-b717-4f9a-8755-dc68c4caeb2d",
"street_address":"2324 Calcite St",
"city_name":"Loveland",
"state_abbreviation":"CO",
"zipcode":"80537",
"county_name":null,
"trust_name":null,
"property_type":"APARTMENT",
"vesting_code":null,
"user_permissions":["R","U"],
"credit_application": 78de5b35-9140-42b4-94e2-d48c52c163a5,
"title_application": null,
"property_application": null,
"application_category": “CREDIT”,
"application_stage": “regular”
}
Update Legal Site
- PUT /api/v1/legal_address/{uuid}/
- Body (any combination of):
- {"street_address":"2324 Calcite St"}
- {"city_name":"Loveland"}
- {"state_abbreviation":"CO"}
- {"zipcode":"80537"}
- {"county_name":null}
- {"trust_name":null}
- {"property_type":"APARTMENT”}
- {"vesting_code":null}
Add External ID
- POST to one of:
- /api/v1/credit_application/{uuid}/external_id/
- /api/v1/title_application/{uuid}/external_id/
- /api/v1/property_application/{uuid}/external_id/
- Body:
- {“external_id”: “helloworld”}
- Response:
{
"uuid": "f905357b-5539-456f-baa0-0c603d9ba5d8",
"organization": "e3043913-0b57-4f2c-8f7e-b8b367c0e925",
"remote_service": null,
"external_id": "helloworld"
}
And the next time you GET the application it will be in the external_ids field:
{
"uuid": "13613f14-e54d-4f8e-8eb4-dcbf49b56b62",
"status": "INITIATED",
"is_prequal": false,
"access_token": "72dc0ea80ef74bef80498cf801b7aeb7",
"application_mode": "EMAIL",
"date_initiated": "2017-11-15T06:36:23.995260Z",
"date_submitted": null,
"application_process": "6d159695-99ed-46f0-be0f-c59845dde610",
"qualification": "46f9694d-8963-4504-9fd3-2e4760f01e6b",
"application_url": "https://sandbox2.sighten.io/solar/pipeline/credit_auth/?token=72dc0ea80ef74bef80498cf801b7aeb7",
"application_stage": "regular",
"application_category": "CREDIT",
"date_updated": "2017-11-15T06:36:23.995417Z",
"external_ids": [
{
"uuid": "f905357b-5539-456f-baa0-0c603d9ba5d8",
"organization": "e3043913-0b57-4f2c-8f7e-b8b367c0e925",
"remote_service": null,
"external_id": "helloworld"
}
]
}