Approval

An automated pre-approval issued from verified inputs, without an underwriter in the loop.

Given verified identity, credit, income, assets and a priced product, the product issues a conditional approval and generates the letter. The conditions it carries are the checks that have not yet been satisfied, stated explicitly.

The borrower-facing flow is configurable through the API rather than by deployment: branding, the opening screen, and what happens after issuance — including pushing the resulting file into the lender's origination system.

How it works

The decision is only as good as its inputs, so the product does not accept self-reported figures. Every input it consumes carries which vendor produced it and when, and an input without that provenance is treated as unverified.

The conversational flow that gathers those inputs is documented under the consumer application.

Operations

After Actions

GET /after-actions

Retrieve All After Actions

getAfterAllActions

Retrieve After Actions

Retrieve all existing after actions in the pre-approval application.

Response

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

Other responses

200

DELETE /after-actions/{type}

Delete After Action

deleteAfterAction

Response

application/json

Create After Action API Triggered Successfully

{
  "type": "success-page",
  "value": "SIMPLE_SUCCESS"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Parameters

Parameter	Type	Example	Description
`type` required	`string` path	`success-page`	After Action type

Response `200application/json`

2 fields

Create After Action API Triggered Successfully

Field	Type	Description
`type`	`string`	Type`success-page`
`value`	`string`	Value`SIMPLE_SUCCESSWITH_AUS_PDFs`

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

Other responses

409

POST /after-actions/{type}

Create After Action

createAfterAction

Request

application/json

{
  "type": "SIMPLE_SUCCESS"
}

Response

application/json

Create After Action API Triggered Successfully

{
  "type": "success-page",
  "value": "SIMPLE_SUCCESS"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Parameters

Parameter	Type	Example	Description
`type` required	`string` path	`success-page`	After Action type

Response `201application/json`

2 fields

Create After Action API Triggered Successfully

Field	Type	Description
`type`	`string`	Type`success-page`
`value`	`string`	Value`SIMPLE_SUCCESSWITH_AUS_PDFs`

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

Other responses

409

GET /after-actions/{type}

Retrieve Settings

getAfterAction

Retrieve After Action

Retrieve after action that describe a pre-approval application.

Response

application/json

Retrieve Flows

{
  "type": "success-page",
  "value": "SIMPLE_SUCCESS"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Parameters

Parameter	Type	Example	Description
`type` required	`string` path	`success-page`	After Action type

Response `200application/json`

2 fields

Retrieve Flows

Field	Type	Description
`type`	`string`	Type`success-page`
`value`	`string`	Value`SIMPLE_SUCCESSWITH_AUS_PDFs`

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

POST /after-actions/success-page

Success Page Create

createSuccessPageAfterAction

Create Success Page After Action

Create Success Page After Action. You can define one of 2 types: SIMPLE_SUCCESS or WITH_AUS_PDFs. SIMPLE_SUCCESS will display simple success page, while WITH_AUS_PDFs - will also display links to all the documents AUS product provide.

Request

application/json

{
  "type": "SIMPLE_SUCCESS"
}

Response

application/json

Create Success Page Triggered Successfully

{
  "type": "SIMPLE_SUCCESS"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Request body`application/json`

1 fields

Field	Type	Description
`type`required	`string`	Type`SIMPLE_SUCCESSWITH_AUS_PDFs`

Response `201application/json`

1 fields

Create Success Page Triggered Successfully

Field	Type	Description
`type`	`string`	Type`SIMPLE_SUCCESSWITH_AUS_PDFs`

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

Other responses

409

GET /after-actions/success-page

Success Page Retrieve

getSuccessPage

Retrieve Success Page

Response

application/json

Retrieve Success Page

{
  "type": "SIMPLE_SUCCESS"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Response `200application/json`

1 fields

Retrieve Success Page

Field	Type	Description
`type`	`string`	Type`SIMPLE_SUCCESSWITH_AUS_PDFs`

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

PUT /after-actions/{type}

Update After Action

updateAfterAction

Update After Action that describe a pre-approval application.

Response

application/json

Retrieve Flows

{
  "type": "success-page",
  "value": "SIMPLE_SUCCESS"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Parameters

Parameter	Type	Example	Description
`type` required	`string` path	`success-page`	After Action type

Response `200application/json`

2 fields

Retrieve Flows

Field	Type	Description
`type`	`string`	Type`success-page`
`value`	`string`	Value`SIMPLE_SUCCESSWITH_AUS_PDFs`

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Other responses

404

PUT /after-actions/success-page

Success Page Update

UpdateSuccessPageAfterAction

Update Success Page After Action

Update Success Page After Action. You can define one of 2 types: SIMPLE_SUCCESS or WITH_AUS_PDFs. SIMPLE_SUCCESS will display simple success page, while WITH_AUS_PDFs - will also display links to all the documents AUS product provide.

Request

application/json

{
  "type": "SIMPLE_SUCCESS"
}

Response

application/json

Create Success Page Triggered Successfully

{
  "type": "SIMPLE_SUCCESS"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Request body`application/json`

1 fields

Field	Type	Description
`type`required	`string`	Type`SIMPLE_SUCCESSWITH_AUS_PDFs`

Response `201application/json`

1 fields

Create Success Page Triggered Successfully

Field	Type	Description
`type`	`string`	Type`SIMPLE_SUCCESSWITH_AUS_PDFs`

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

Other responses

409

POST /after-actions/los-push

LOS Push Create

createLosPushAfterAction

Create LOS Push After Action

Create LOS Push After Action. This action will use result collection and will send it to an appropriate LOS Adapters. Right now we support only Encompass Output Adapter

Request

application/json

{
  "los_vendor": "Encompass"
}

Response

application/json

Create LOS Push Triggered Successfully

{
  "los_vendor": "Encompass"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Request body`application/json`

1 fields

Field	Type	Description
`los_vendor`required	`string`	LOS Vendor name`ByteEncompass`

Response `201application/json`

2 fields

Create LOS Push Triggered Successfully

Field	Type	Description
`type`	`string`	Type`los-push`
`vendor`	`string`	Vendor`ByteEncompass`

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

Other responses

409

GET /after-actions/los-push

LOS Push Retrieve

getLosPush

Retrieve LOS Push After Action

Retrieve LOS Push

Response

application/json

Retrieve LOS Push

{
  "los_vendor": "Encompass"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Response `200application/json`

2 fields

Retrieve LOS Push

Field	Type	Description
`type`	`string`	Type`los-push`
`vendor`	`string`	Vendor`ByteEncompass`

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

PUT /after-actions/los-push

LOS Push Update

updateLosPushAfterAction

Update LOS Push After Action

Update LOS Push After Action. This action will use result collection and will send it to an appropriate LOS Adapters. Right now we support only Encompass Output Adapter

Request

application/json

{
  "los_vendor": "Encompass"
}

Response

application/json

Create LOS Push Triggered Successfully

{
  "los_vendor": "Encompass"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Request body`application/json`

1 fields

Field	Type	Description
`los_vendor`required	`string`	LOS Vendor name`ByteEncompass`

Response `201application/json`

2 fields

Create LOS Push Triggered Successfully

Field	Type	Description
`type`	`string`	Type`los-push`
`vendor`	`string`	Vendor`ByteEncompass`

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

Other responses

409

POST /after-actions/email-notification

Email Send Create

createSendEmailAfterAction

Create Email Send After Action

Create Email Send After Action.

Request

application/json

{
  "notify_emails": [
    "email1@email.com",
    "email2@email.com"
  ]
}

Response

application/json

Create Send Email Request Triggered Successfully

{
  "notify_emails": [
    "email1@email.com",
    "email2@email.com"
  ]
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Request body`application/json`

1 fields

Field	Type	Description
`email_send`required	`boolean`	After action

Response `201application/json`

1 fields

Create Send Email Request Triggered Successfully

Field	Type	Description
`email_send`required	`boolean`	After action

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

GET /after-actions/email-notification

Email Send Retrieve

getEmailSend

Retrieve Email Send After Action

Retrieve Email Send

Response

application/json

Retrieve Email Send

{
  "notify_emails": [
    "email1@email.com",
    "email2@email.com"
  ]
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Response `200application/json`

1 fields

Retrieve Email Send

Field	Type	Description
`email_send`required	`boolean`	After action

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

PUT /after-actions/email-notification

Email Send Update

updateEmailSendAfterAction

Update Email Send After Action

Update Email Send After Action.

Request

application/json

{
  "notify_emails": [
    "email1@email.com",
    "email2@email.com"
  ]
}

Response

application/json

Update Email Send Request Triggered Successfully

{
  "notify_emails": [
    "email1@email.com",
    "email2@email.com"
  ]
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Request body`application/json`

1 fields

Field	Type	Description
`email_send`required	`boolean`	After action

Response `201application/json`

1 fields

Update Email Send Request Triggered Successfully

Field	Type	Description
`email_send`required	`boolean`	After action

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

Other responses

409

Console

PUT /archive-document/{transaction_id}

Get doc

get-docs-archtra

Put doc

Response

application/json

OK.

{
  "message": "success"
}

Parameters

Parameter	Type	Example	Description
`x-api-key` required	`string` header	`<redacted>`	Key used to identify the API usage plan
`transaction_id` required	`string` path	`example`	transaction_id

Response `200application/json`

1 fields

OK.

Field	Type	Description
`message`	`string`	Message

DELETE /documents/{transaction_id}

Get doc

del-doc

Response

application/json

OK.

{
  "message": "success"
}

Parameters

Parameter	Type	Example	Description
`x-api-key` required	`string` header	`<redacted>`	Key used to identify the API usage plan
`transaction_id` required	`string` path	`example`	transaction_id

Response `200application/json`

1 fields

OK.

Field	Type	Description
`message`	`string`	Message

GET /get-documents

Get doc

get-docs

Response

application/json

OK.

{
  "message": "success"
}

Parameters

Parameter	Type	Example	Description
`x-api-key` required	`string` header	`<redacted>`	Key used to identify the API usage plan

Response `200application/json`

1 fields

OK.

Field	Type	Description
`message`	`string`	Message

GET /get-documents/archived

Get doc

get-docs-arch

Response

application/json

OK.

{
  "message": "success"
}

Parameters

Parameter	Type	Example	Description
`x-api-key` required	`string` header	`<redacted>`	Key used to identify the API usage plan

Response `200application/json`

1 fields

OK.

Field	Type	Description
`message`	`string`	Message

PUT /password

Get doc

password

Put doc

Response

application/json

OK.

{
  "message": "success"
}

Parameters

Parameter	Type	Example	Description
`x-api-key` required	`string` header	`<redacted>`	Key used to identify the API usage plan

Response `200application/json`

1 fields

OK.

Field	Type	Description
`message`	`string`	Message

POST /save-document

Sign In

ssave

Request

application/json

An example of a payload.

{
  "email": "john.doe@company.com",
  "password": "XXXXX"
}

Response

application/json

OK.

{
  "message": "success"
}

Parameters

Parameter	Type	Example	Description
`x-api-key` required	`string` header	`<redacted>`	Key used to identify the API usage plan

Request body`application/json`

2 fields

Field	Type	Description
`email`required	`string`	Email of accountExample `john.doe@company.com`
`password`required	`string`	Password of accountExample `XXXXX`

Response `200application/json`

1 fields

OK.

Field	Type	Description
`message`	`string`	Message

POST /sign-in

Sign In

sign-in

Request

application/json

An example of a payload.

{
  "email": "john.doe@company.com",
  "password": "XXXXX"
}

Response

application/json

OK.

{
  "message": "success"
}

Parameters

Parameter	Type	Example	Description
`x-api-key` required	`string` header	`<redacted>`	Key used to identify the API usage plan

Request body`application/json`

2 fields

Field	Type	Description
`email`required	`string`	Email of accountExample `john.doe@company.com`
`password`required	`string`	Password of accountExample `XXXXX`

Response `200application/json`

1 fields

OK.

Field	Type	Description
`message`	`string`	Message

POST /sign-up

Sign Up

sign-up

Request

application/json

An example of a payload.

{
  "email": "john.doe@company.com",
  "password": "XXXXX"
}

Response

application/json

OK.

{
  "message": "success"
}

Parameters

Parameter	Type	Example	Description
`x-api-key` required	`string` header	`<redacted>`	Key used to identify the API usage plan

Request body`application/json`

2 fields

Field	Type	Description
`email`required	`string`	Email of accountExample `john.doe@company.com`
`password`required	`string`	Password of accountExample `XXXXX`

Response `200application/json`

1 fields

OK.

Field	Type	Description
`message`	`string`	Message

Data Bank

GET /data-bank

Retrieve Data-Bank

getDataBank

Retrieve Pre-Approval Data-Bank

Retrieve Pre-Approval Data-Bank. Data bank will be returned in form of Persistence Collection defined by Staircase Lexicon

Response

application/json

Retrieve Flows

{
  "people": [
    {
      "@id": "7fd03afb-6b64-4943-86bd-d24d9aa47c0b",
      "@type": "borrower",
      "has_marital_status_type": {
        "has_value": "unmarried"
      }
    }
  ]
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

Other responses

200

PUT /data-bank

Update Data-Bank

updateDataBank

Update Pre-Approval Data-Bank

Update Pre-Approval Data-Bank. To be able to update Data bank it is required to use valid data in form Staircase Language.

Request

application/json

{
  "people": [
    {
      "@id": "7fd03afb-6b64-4943-86bd-d24d9aa47c0b",
      "@type": "borrower",
      "has_marital_status_type": {
        "has_value": "unmarried"
      }
    }
  ]
}

Response

application/json

Retrieve Flows

{
  "@id": "7fd03afb-6b64-4943-86bd-d24d9aa47c0b",
  "@type": "borrower",
  "has_marital_status_type": "unmarried"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

Other responses

201

Executions

GET /executions

Retrieve Borrowers Executions

getExecutions

Retrieve a list of borrower-executed workflows.

Response

application/json

Retrieve Flows

{
  "message": "The product has encountered an internal server error"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Response `200application/json`

1 fields

Retrieve Flows

Field	Type	Description
`message`	`string`	Error Message

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

Flows

POST /flows

Create Flow

createFlow

Create a workflow for a pre-approval application. Flow types can be SMART, STATED or VERIFIED. A SMART flow collects data through technology partner only when it is required. A STATED flow collects data directly from the borrower. For a VERIFIED flow, data is collected and/or verified through a technology partner.

Request

application/json

{
  "type": "STATED"
}

Response

application/json

Create Flow API Triggered Successfully

{
  "type": "SMART",
  "brand_color": "#AAAAAA",
  "@id": "9c39b029-409e-4f78-b72e-8f1d05b17940"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Request body`application/json`

1 fields

Field	Type	Description
`type`required	`string`	Flow type`SMARTSTATEDVERIFIED`

Response `201application/json`

1 fields

Create Flow API Triggered Successfully

Field	Type	Description
`type`	`string`	Flow Type`SMARTSTATEDVERIFIED`

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

Other responses

409

GET /flows/{id}

Retrieve Flow

getFlow

Retrieve a specific workflow that has been created for a pre-approval application.

Response

application/json

Retrieve Job

{
  "value": {
    "brand_color": "#AAAAAA",
    "@id": "9c39b029-409e-4f78-b72e-8f1d05b17940",
    "@type": "SMART"
  }
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Parameters

Parameter	Type	Example	Description
`id` required	`string` path	`example`	Flow id

Response `200application/json`

3 fields

Retrieve Job

Field	Type	Description
`brand_color`	`string`	Brand color
`@id`	`string`	—
`@type`	`string`	—

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `404application/json`

1 fields

Not Found

Field	Type	Description
`message`	`string`	Error message

GET /flows

Retrieve All Flows

listFlows

Retrieve all existing workflows that have been created for a pre-approval application.

Response

application/json

Retrieve Flows

{
  "message": "The product has encountered an internal server error"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Response `200application/json`

1 fields

Retrieve Flows

Field	Type	Description
`message`	`string`	Error Message

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

DELETE /flows/{id}

Delete Flow

deleteFlow

Update Flow

Response

application/json

Update an existing flow that has been created for a pre-approval application.

{
  "value": {
    "message": "Success!"
  }
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Parameters

Parameter	Type	Example	Description
`id` required	`string` path	`Id`	Flow id

Response `200application/json`

1 fields

Update an existing flow that has been created for a pre-approval application.

Field	Type	Description
`message`	`string`	Delete Result

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `404application/json`

1 fields

Not Found

Field	Type	Description
`message`	`string`	Error message

PUT /flows/{id}

Update Flow

updateFlow

Request

application/json

{
  "type": "STATED"
}

Response

application/json

Update an existing flow that has been created for a pre-approval application.

{
  "value": {
    "brand_color": "#AAAAAA",
    "@id": "9c39b029-409e-4f78-b72e-8f1d05b17940",
    "@type": "CLASSIFY"
  }
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Parameters

Parameter	Type	Example	Description
`id` required	`string` path	`Id`	Flow id

Request body`application/json`

1 fields

Field	Type	Description
`type`required	`string`	Flow type`CLASSIFYSTATEDVERIFIED`

Response `200application/json`

3 fields

Update an existing flow that has been created for a pre-approval application.

Field	Type	Description
`brand_color`	`string`	Brand color
`@id`	`string`	—
`@type`	`string`	—

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `404application/json`

1 fields

Not Found

Field	Type	Description
`message`	`string`	Error message

Links

GET /links

Retrieve Link

getLink

Retrieves a custom web link for a pre-approval application. Lenders can use the web link on their own websites and send it to prospective borrowers.

Response

application/json

Retrieve Flows

{
  "type": "SMART",
  "brand_color": "#AAAAAA",
  "@id": "9c39b029-409e-4f78-b72e-8f1d05b17940"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Parameters

Parameter	Type	Example	Description
`type` required	`string` query	`borrower_link`	Link type

Response `200application/json`

1 fields

Retrieve Flows

Field	Type	Description
`type`	`string`	Flow Type`SMARTSTATEDVERIFIED`

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

Self Checks

GET /self-checks

Retrieve Self Checks

getSelfChecks

Retrieves all existing self-checks

Response

application/json

Retrieve Self Checks

[
  {
    "job_name": "job_name",
    "description": "description",
    "trigger_name": "trigger_name",
    "status": "FAILED",
    "updated_at": "2020-07-21 15:35:36.109000+00:00"
  }
]

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Response `200application/json`

5 fields

Retrieve Self Checks

Field	Type	Description
`job_name`	`string`	—
`trigger_name`	`string`	—
`description`	`string`	—
`updated_at`	`string`	—
`status`	`string`	`FAILEDSUCCEEDED`

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

Settings

POST /settings

Create Settings

createSettings

Create settings that describe a pre-approval application.

Request

application/json

{
  "type": "brand_color"
}

Response

application/json

Create Setting API Triggered Successfully

{
  "type": "SMART",
  "brand_color": "#AAAAAA",
  "@id": "9c39b029-409e-4f78-b72e-8f1d05b17940"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Request body`application/json`

1 fields

Field	Type	Description
`type`required	`string`	Setting type`brand_color`

Response `201application/json`

1 fields

Create Setting API Triggered Successfully

Field	Type	Description
`type`	`string`	Flow Type`SMARTSTATEDVERIFIED`

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

Other responses

409

GET /settings

Retrieve Settings

getSettings

Retrieve settings that describe a pre-approval application.

Response

application/json

Retrieve Flows

{
  "type": "SMART",
  "brand_color": "#AAAAAA",
  "@id": "9c39b029-409e-4f78-b72e-8f1d05b17940"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Parameters

Parameter	Type	Example	Description
`type`	`string` query	`borrower_link`	Flow type

Response `200application/json`

1 fields

Retrieve Flows

Field	Type	Description
`type`	`string`	Flow Type`SMARTSTATEDVERIFIED`

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

POST /settings/brand_color

Brand Color Create

createBrandColorSetting

Create Brand Color

Create Brand Color Setting. You can define only HEX string.

Request

application/json

{
  "brand_color": "#FFFFFF"
}

Response

application/json

Create Brand Color Triggered Successfully

{
  "brand_color": "#FFFFFF"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Request body`application/json`

1 fields

Field	Type	Description
`brand_color`required	`string`	Brand Color

Response `201application/json`

1 fields

Create Brand Color Triggered Successfully

Field	Type	Description
`brand_color`required	`string`	Brand Color

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

Other responses

409

POST /settings/company_name

Company Name Create

createCompanyNameSetting

Create Company Name

Create Company Name Setting. You can define only string.

Request

application/json

{
  "company_name": "Staircase"
}

Response

application/json

Create Company Name Triggered Successfully

{
  "company_name": "Staircase"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Request body`application/json`

1 fields

Field	Type	Description
`company_name`required	`string`	Company Name

Response `201application/json`

1 fields

Create Company Name Triggered Successfully

Field	Type	Description
`company_name`required	`string`	Company Name

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

Other responses

409

PUT /settings

Update Setting

updateSetting

Update settings that describe a pre-approval application.

Response

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Other responses

204404

GET /settings/brand_color

Brand Color Retrieve

getBrandColorSetting

Retrieve Brand Color Setting

Retrieve Brand Color

Response

application/json

Retrieve Brand Color

{
  "brand_color": "#FFFFFF"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Response `200application/json`

1 fields

Retrieve Brand Color

Field	Type	Description
`brand_color`required	`string`	Brand Color

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

GET /settings/company_name

Company Name Retrieve

getCompanyNameSetting

Retrieve Company Name Setting

Retrieve Company Name

Response

application/json

Retrieve Company Name

{
  "company_name": "Staircase"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Response `200application/json`

1 fields

Retrieve Company Name

Field	Type	Description
`company_name`required	`string`	Company Name

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

PUT /settings/brand_color

Brand Color Update

updateSettingBrandColor

Update Brand Color Setting

Update Brand Color

Request

application/json

{
  "brand_color": "#FFFFFF"
}

Response

application/json

Update Brand Color

{
  "brand_color": "#FFFFFF"
}

Request body`application/json`

1 fields

Field	Type	Description
`brand_color`required	`string`	Brand Color

Response `200application/json`

1 fields

Update Brand Color

Field	Type	Description
`brand_color`required	`string`	Brand Color

PUT /settings/company_name

Company Name Update

updateSettingCompanyName

Update Company Name Setting

Update Company Name

Request

application/json

{
  "company_name": "Staircase"
}

Response

application/json

Update Company Name

{
  "company_name": "Staircase"
}

Request body`application/json`

1 fields

Field	Type	Description
`company_name`required	`string`	Company Name

Response `200application/json`

1 fields

Update Company Name

Field	Type	Description
`company_name`required	`string`	Company Name

POST /settings/welcome_screen

Welcome Screen Create

createWelcomeScreenSetting

Create Welcome Screen

Create Welcome Screen Setting. You can define only BOOLEAN values.

Request

application/json

{
  "welcome_screen": true
}

Response

application/json

Create Welcome Screen Triggered Successfully

{
  "welcome_screen": true
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Request body`application/json`

1 fields

Field	Type	Description
`welcome_screen`required	`boolean`	Welcome Screen

Response `201application/json`

1 fields

Create Welcome Screen Triggered Successfully

Field	Type	Description
`welcome_screen`required	`boolean`	Welcome Screen

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

Other responses

409

GET /settings/welcome_screen

Welcome Screen Retrieve

getWelcomeScreenSetting

Retrieve Welcome Screen Setting

Retrieve Welcome Screen

Response

application/json

Retrieve Welcome Screen

{
  "welcome_screen": true
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Response `200application/json`

1 fields

Retrieve Welcome Screen

Field	Type	Description
`welcome_screen`required	`boolean`	Welcome Screen

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

PUT /settings/welcome_screen

Welcome Screen Update

updateWelcomeScreenColor

Update Welcome Screen Setting

Update Welcome Screen

Request

application/json

{
  "welcome_screen": true
}

Response

application/json

Update Welcome Screen

{
  "welcome_screen": true
}

Request body`application/json`

1 fields

Field	Type	Description
`welcome_screen`required	`boolean`	Welcome Screen

Response `200application/json`

1 fields

Update Welcome Screen

Field	Type	Description
`welcome_screen`required	`boolean`	Welcome Screen

PUT /settings/logo

Upload logo

UploadLogo

Upload Logo

Upload logo: Uploads company logo for Nav Bar

Request

multipart/form-data

Upload new logo

{
  "image": {
    "externalValue": "https://staircase.co/images/yellow-stairs.png"
  }
}

Response

application/json

Upload New Logo Triggered Successfully

{
  "status": "SUCCEEDED",
  "blob_id": "01G3H1DQMK3BC24V1PP15PNHC3"
}

application/json

Invalid key for service

{
  "message": "Please check the key you used to call this service",
  "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}

Request body`multipart/form-data`

1 fields

Field	Type	Description
`image`	`string (binary)`	Image to upload

Response `201application/json`

2 fields

Upload New Logo Triggered Successfully

Field	Type	Description
`status`	`string`	Status process
`blob_id`	`string`	Image Blob ID

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `500application/json`

1 fields

The product has encountered an internal server error

Field	Type	Description
`message`	`string`	Error Message

Other responses

409

Errors

403404409500

How it works

Operations

After Actions

Retrieve All After Actions

Response

Response 403application/json

Response 500application/json

Other responses

Delete After Action

Response

Parameters

Response 200application/json

Response 403application/json

Response 500application/json

Other responses

Create After Action

Request

Response

Parameters

Response 201application/json

Response 403application/json

Response 500application/json

Other responses

Retrieve Settings

Response

Parameters

Response 200application/json

Response 403application/json

Response 500application/json

Success Page Create

Request

Response

Request bodyapplication/json

Response 201application/json

Response 403application/json

Response 500application/json

Other responses

Success Page Retrieve

Response

Response 200application/json

Response 403application/json

Response 500application/json

Update After Action

Response

Parameters

Response 200application/json

Response 403application/json

Other responses

Success Page Update

Request

Response

Request bodyapplication/json

Response 201application/json

Response 403application/json

Response 500application/json

Other responses

LOS Push Create

Request

Response

Request bodyapplication/json

Response 201application/json

Response 403application/json

Response 500application/json

Other responses

LOS Push Retrieve

Response

Response 200application/json

Response 403application/json

Response 500application/json

LOS Push Update

Request

Response

Request bodyapplication/json

Response 201application/json

Response 403application/json

Response 500application/json

Other responses

Email Send Create

Request

Response

Response `403application/json`

Response `500application/json`

Response `200application/json`

Response `403application/json`

Response `500application/json`

Response `201application/json`

Response `403application/json`

Response `500application/json`

Response `200application/json`

Response `403application/json`

Response `500application/json`

Request body`application/json`

Response `201application/json`

Response `403application/json`

Response `500application/json`

Response `200application/json`

Response `403application/json`

Response `500application/json`

Response `200application/json`

Response `403application/json`

Request body`application/json`

Response `201application/json`

Response `403application/json`

Response `500application/json`

Request body`application/json`

Response `201application/json`

Response `403application/json`

Response `500application/json`

Response `200application/json`

Response `403application/json`

Response `500application/json`

Request body`application/json`

Response `201application/json`

Response `403application/json`

Response `500application/json`

Request body`application/json`

Response `201application/json`

Response `403application/json`

Response `500application/json`

Response `200application/json`

Response `403application/json`

Response `500application/json`

Request body`application/json`

Response `201application/json`

Response `403application/json`

Response `500application/json`

Response `200application/json`

Response `200application/json`

Response `200application/json`

Response `200application/json`

Response `200application/json`

Request body`application/json`

Response `200application/json`

Request body`application/json`

Response `200application/json`

Request body`application/json`

Response `200application/json`

Response `403application/json`

Response `500application/json`

Response `403application/json`

Response `500application/json`