<!-- https://staircase.co/products/automation/approval -->
# Approval

# 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

<!--source:api-specifications-->

### After Actions
<!--/source-->

`GET` `/after-actions`

<!--source:api-specifications-->

#### Retrieve All After Actions
<!--/source-->

`getAfterAllActions`

<!--source:api-specifications-->
Retrieve After Actions
<!--/source-->

<!--source:api-specifications-->
Retrieve all existing after actions in the pre-approval application.

<!--/source-->

##### Response

<!--source:api-specifications-->
403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

##### Other responses

`200`

`DELETE` `/after-actions/{type}`

<!--source:api-specifications-->

#### Delete After Action
<!--/source-->

`deleteAfterAction`

##### Response

<!--source:api-specifications-->
200403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Create After Action API Triggered Successfully

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Parameters

<!--source:api-specifications-->
1
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `type` required | `string` path | `success-page` | <!--source:api-specifications-->After Action type<!--/source--> |

##### Response `200``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Create After Action API Triggered Successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `type` | `string` | <!--source:api-specifications-->Type<!--/source-->`success-page` |
| `value` | `string` | <!--source:api-specifications-->Value<!--/source-->`SIMPLE_SUCCESS``WITH_AUS_PDFs` |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

##### Other responses

`409`

`POST` `/after-actions/{type}`

<!--source:api-specifications-->

#### Create After Action
<!--/source-->

`createAfterAction`

##### Request

<!--source:api-specifications-->
CreateSuccessPageAfterActionCreateLosVendorAfterAction
<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "type": "SIMPLE_SUCCESS"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "los_vendor": "Encompass"
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
201403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Create After Action API Triggered Successfully

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Parameters

<!--source:api-specifications-->
1
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `type` required | `string` path | `success-page` | <!--source:api-specifications-->After Action type<!--/source--> |

##### Response `201``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Create After Action API Triggered Successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `type` | `string` | <!--source:api-specifications-->Type<!--/source-->`success-page` |
| `value` | `string` | <!--source:api-specifications-->Value<!--/source-->`SIMPLE_SUCCESS``WITH_AUS_PDFs` |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

##### Other responses

`409`

`GET` `/after-actions/{type}`

<!--source:api-specifications-->

#### Retrieve Settings
<!--/source-->

`getAfterAction`

<!--source:api-specifications-->
Retrieve After Action
<!--/source-->

<!--source:api-specifications-->
Retrieve after action that describe a pre-approval application.

<!--/source-->

##### Response

<!--source:api-specifications-->
200403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Retrieve Flows

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Parameters

<!--source:api-specifications-->
1
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `type` required | `string` path | `success-page` | <!--source:api-specifications-->After Action type<!--/source--> |

##### Response `200``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Retrieve Flows
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `type` | `string` | <!--source:api-specifications-->Type<!--/source-->`success-page` |
| `value` | `string` | <!--source:api-specifications-->Value<!--/source-->`SIMPLE_SUCCESS``WITH_AUS_PDFs` |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

`POST` `/after-actions/success-page`

<!--source:api-specifications-->

#### Success Page Create
<!--/source-->

`createSuccessPageAfterAction`

<!--source:api-specifications-->
Create Success Page After Action
<!--/source-->

<!--source:api-specifications-->
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.

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "type": "SIMPLE_SUCCESS"
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
201403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Create Success Page Triggered Successfully

```
{
 "type": "SIMPLE_SUCCESS"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Request body`application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `type`required | `string` | <!--source:api-specifications-->Type<!--/source-->`SIMPLE_SUCCESS``WITH_AUS_PDFs` |

##### Response `201``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Create Success Page Triggered Successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `type` | `string` | <!--source:api-specifications-->Type<!--/source-->`SIMPLE_SUCCESS``WITH_AUS_PDFs` |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

##### Other responses

`409`

`GET` `/after-actions/success-page`

<!--source:api-specifications-->

#### Success Page Retrieve
<!--/source-->

`getSuccessPage`

<!--source:api-specifications-->
Retrieve Success Page
<!--/source-->

##### Response

<!--source:api-specifications-->
200403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Retrieve Success Page

```
{
 "type": "SIMPLE_SUCCESS"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Retrieve Success Page
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `type` | `string` | <!--source:api-specifications-->Type<!--/source-->`SIMPLE_SUCCESS``WITH_AUS_PDFs` |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

`PUT` `/after-actions/{type}`

<!--source:api-specifications-->

#### Update After Action
<!--/source-->

`updateAfterAction`

<!--source:api-specifications-->
Update After Action that describe a pre-approval application.

<!--/source-->

##### Response

<!--source:api-specifications-->
200403
<!--/source-->

<!--source:api-specifications-->
application/json Copy Retrieve Flows

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

##### Parameters

<!--source:api-specifications-->
1
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `type` required | `string` path | `success-page` | <!--source:api-specifications-->After Action type<!--/source--> |

##### Response `200``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Retrieve Flows
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `type` | `string` | <!--source:api-specifications-->Type<!--/source-->`success-page` |
| `value` | `string` | <!--source:api-specifications-->Value<!--/source-->`SIMPLE_SUCCESS``WITH_AUS_PDFs` |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Other responses

`404`

`PUT` `/after-actions/success-page`

<!--source:api-specifications-->

#### Success Page Update
<!--/source-->

`UpdateSuccessPageAfterAction`

<!--source:api-specifications-->
Update Success Page After Action
<!--/source-->

<!--source:api-specifications-->
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.

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "type": "SIMPLE_SUCCESS"
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
201403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Create Success Page Triggered Successfully

```
{
 "type": "SIMPLE_SUCCESS"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Request body`application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `type`required | `string` | <!--source:api-specifications-->Type<!--/source-->`SIMPLE_SUCCESS``WITH_AUS_PDFs` |

##### Response `201``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Create Success Page Triggered Successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `type` | `string` | <!--source:api-specifications-->Type<!--/source-->`SIMPLE_SUCCESS``WITH_AUS_PDFs` |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

##### Other responses

`409`

`POST` `/after-actions/los-push`

<!--source:api-specifications-->

#### LOS Push Create
<!--/source-->

`createLosPushAfterAction`

<!--source:api-specifications-->
Create LOS Push After Action
<!--/source-->

<!--source:api-specifications-->
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

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "los_vendor": "Encompass"
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
201403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Create LOS Push Triggered Successfully

```
{
 "los_vendor": "Encompass"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Request body`application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `los_vendor`required | `string` | <!--source:api-specifications-->LOS Vendor name<!--/source-->`Byte``Encompass` |

##### Response `201``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Create LOS Push Triggered Successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `type` | `string` | <!--source:api-specifications-->Type<!--/source-->`los-push` |
| `vendor` | `string` | <!--source:api-specifications-->Vendor<!--/source-->`Byte``Encompass` |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

##### Other responses

`409`

`GET` `/after-actions/los-push`

<!--source:api-specifications-->

#### LOS Push Retrieve
<!--/source-->

`getLosPush`

<!--source:api-specifications-->
Retrieve LOS Push After Action
<!--/source-->

<!--source:api-specifications-->
Retrieve LOS Push

<!--/source-->

##### Response

<!--source:api-specifications-->
200403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Retrieve LOS Push

```
{
 "los_vendor": "Encompass"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Response `200``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Retrieve LOS Push
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `type` | `string` | <!--source:api-specifications-->Type<!--/source-->`los-push` |
| `vendor` | `string` | <!--source:api-specifications-->Vendor<!--/source-->`Byte``Encompass` |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

`PUT` `/after-actions/los-push`

<!--source:api-specifications-->

#### LOS Push Update
<!--/source-->

`updateLosPushAfterAction`

<!--source:api-specifications-->
Update LOS Push After Action
<!--/source-->

<!--source:api-specifications-->
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

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "los_vendor": "Encompass"
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
201403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Create LOS Push Triggered Successfully

```
{
 "los_vendor": "Encompass"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Request body`application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `los_vendor`required | `string` | <!--source:api-specifications-->LOS Vendor name<!--/source-->`Byte``Encompass` |

##### Response `201``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Create LOS Push Triggered Successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `type` | `string` | <!--source:api-specifications-->Type<!--/source-->`los-push` |
| `vendor` | `string` | <!--source:api-specifications-->Vendor<!--/source-->`Byte``Encompass` |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

##### Other responses

`409`

`POST` `/after-actions/email-notification`

<!--source:api-specifications-->

#### Email Send Create
<!--/source-->

`createSendEmailAfterAction`

<!--source:api-specifications-->
Create Email Send After Action
<!--/source-->

<!--source:api-specifications-->
Create Email Send After Action.

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "notify_emails": [
 "email1@email.com",
 "email2@email.com"
 ]
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
201403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Create Send Email Request Triggered Successfully

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Request body`application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `email_send`required | `boolean` | <!--source:api-specifications-->After action<!--/source--> |

##### Response `201``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Create Send Email Request Triggered Successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `email_send`required | `boolean` | <!--source:api-specifications-->After action<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

`GET` `/after-actions/email-notification`

<!--source:api-specifications-->

#### Email Send Retrieve
<!--/source-->

`getEmailSend`

<!--source:api-specifications-->
Retrieve Email Send After Action
<!--/source-->

<!--source:api-specifications-->
Retrieve Email Send

<!--/source-->

##### Response

<!--source:api-specifications-->
200403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Retrieve Email Send

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Retrieve Email Send
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `email_send`required | `boolean` | <!--source:api-specifications-->After action<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

`PUT` `/after-actions/email-notification`

<!--source:api-specifications-->

#### Email Send Update
<!--/source-->

`updateEmailSendAfterAction`

<!--source:api-specifications-->
Update Email Send After Action
<!--/source-->

<!--source:api-specifications-->
Update Email Send After Action.

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "notify_emails": [
 "email1@email.com",
 "email2@email.com"
 ]
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
201403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Update Email Send Request Triggered Successfully

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Request body`application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `email_send`required | `boolean` | <!--source:api-specifications-->After action<!--/source--> |

##### Response `201``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Update Email Send Request Triggered Successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `email_send`required | `boolean` | <!--source:api-specifications-->After action<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

##### Other responses

`409`

<!--source:api-specifications-->

### Console
<!--/source-->

`PUT` `/archive-document/{transaction_id}`

<!--source:api-specifications-->

#### Get doc
<!--/source-->

`get-docs-archtra`

<!--source:api-specifications-->
Put doc

<!--/source-->

##### Response

<!--source:api-specifications-->
application/json Copy OK.

```
{
 "message": "success"
}
```

<!--/source-->

##### Parameters

<!--source:api-specifications-->
2
<!--/source-->

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

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
OK.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

`DELETE` `/documents/{transaction_id}`

<!--source:api-specifications-->

#### Get doc
<!--/source-->

`del-doc`

##### Response

<!--source:api-specifications-->
application/json Copy OK.

```
{
 "message": "success"
}
```

<!--/source-->

##### Parameters

<!--source:api-specifications-->
2
<!--/source-->

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

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
OK.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

`GET` `/get-documents`

<!--source:api-specifications-->

#### Get doc
<!--/source-->

`get-docs`

##### Response

<!--source:api-specifications-->
application/json Copy OK.

```
{
 "message": "success"
}
```

<!--/source-->

##### Parameters

<!--source:api-specifications-->
1
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `<redacted>` | <!--source:api-specifications-->Key used to identify the API usage plan<!--/source--> |

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
OK.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

`GET` `/get-documents/archived`

<!--source:api-specifications-->

#### Get doc
<!--/source-->

`get-docs-arch`

##### Response

<!--source:api-specifications-->
application/json Copy OK.

```
{
 "message": "success"
}
```

<!--/source-->

##### Parameters

<!--source:api-specifications-->
1
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `<redacted>` | <!--source:api-specifications-->Key used to identify the API usage plan<!--/source--> |

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
OK.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

`PUT` `/password`

<!--source:api-specifications-->

#### Get doc
<!--/source-->

`password`

<!--source:api-specifications-->
Put doc

<!--/source-->

##### Response

<!--source:api-specifications-->
application/json Copy OK.

```
{
 "message": "success"
}
```

<!--/source-->

##### Parameters

<!--source:api-specifications-->
1
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `<redacted>` | <!--source:api-specifications-->Key used to identify the API usage plan<!--/source--> |

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
OK.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

`POST` `/save-document`

<!--source:api-specifications-->

#### Sign In
<!--/source-->

`ssave`

<!--source:api-specifications-->
Sign in
<!--/source-->

<!--source:api-specifications-->
Sign In

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy An example of a payload.

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

<!--/source-->

##### Response

<!--source:api-specifications-->
application/json Copy OK.

```
{
 "message": "success"
}
```

<!--/source-->

##### Parameters

<!--source:api-specifications-->
1
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `<redacted>` | <!--source:api-specifications-->Key used to identify the API usage plan<!--/source--> |

##### Request body`application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `email`required | `string` | <!--source:api-specifications-->Email of account<!--/source-->Example `john.doe@company.com` |
| `password`required | `string` | <!--source:api-specifications-->Password of account<!--/source-->Example `XXXXX` |

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
OK.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

`POST` `/sign-in`

<!--source:api-specifications-->

#### Sign In
<!--/source-->

`sign-in`

<!--source:api-specifications-->
Sign in
<!--/source-->

<!--source:api-specifications-->
Sign In

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy An example of a payload.

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

<!--/source-->

##### Response

<!--source:api-specifications-->
application/json Copy OK.

```
{
 "message": "success"
}
```

<!--/source-->

##### Parameters

<!--source:api-specifications-->
1
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `<redacted>` | <!--source:api-specifications-->Key used to identify the API usage plan<!--/source--> |

##### Request body`application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `email`required | `string` | <!--source:api-specifications-->Email of account<!--/source-->Example `john.doe@company.com` |
| `password`required | `string` | <!--source:api-specifications-->Password of account<!--/source-->Example `XXXXX` |

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
OK.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

`POST` `/sign-up`

<!--source:api-specifications-->

#### Sign Up
<!--/source-->

`sign-up`

<!--source:api-specifications-->
Sign up
<!--/source-->

<!--source:api-specifications-->
Sign Up

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy An example of a payload.

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

<!--/source-->

##### Response

<!--source:api-specifications-->
application/json Copy OK.

```
{
 "message": "success"
}
```

<!--/source-->

##### Parameters

<!--source:api-specifications-->
1
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `<redacted>` | <!--source:api-specifications-->Key used to identify the API usage plan<!--/source--> |

##### Request body`application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `email`required | `string` | <!--source:api-specifications-->Email of account<!--/source-->Example `john.doe@company.com` |
| `password`required | `string` | <!--source:api-specifications-->Password of account<!--/source-->Example `XXXXX` |

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
OK.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Message<!--/source--> |

<!--source:api-specifications-->

### Data Bank
<!--/source-->

`GET` `/data-bank`

<!--source:api-specifications-->

#### Retrieve Data-Bank
<!--/source-->

`getDataBank`

<!--source:api-specifications-->
Retrieve Pre-Approval Data-Bank
<!--/source-->

<!--source:api-specifications-->
Retrieve Pre-Approval Data-Bank. Data bank will be returned in form of Persistence Collection defined by Staircase Lexicon

<!--/source-->

##### Response

<!--source:api-specifications-->
200403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Retrieve Flows

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

##### Other responses

`200`

`PUT` `/data-bank`

<!--source:api-specifications-->

#### Update Data-Bank
<!--/source-->

`updateDataBank`

<!--source:api-specifications-->
Update Pre-Approval Data-Bank
<!--/source-->

<!--source:api-specifications-->
Update Pre-Approval Data-Bank. To be able to update Data bank it is required to use valid data in form Staircase Language.

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "people": [
 {
 "@id": "7fd03afb-6b64-4943-86bd-d24d9aa47c0b",
 "@type": "borrower",
 "has_marital_status_type": {
 "has_value": "unmarried"
 }
 }
 ]
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
201403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Retrieve Flows

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

##### Other responses

`201`

<!--source:api-specifications-->

### Executions
<!--/source-->

`GET` `/executions`

<!--source:api-specifications-->

#### Retrieve Borrowers Executions
<!--/source-->

`getExecutions`

<!--source:api-specifications-->
Retrieve a list of borrower-executed workflows.

<!--/source-->

##### Response

<!--source:api-specifications-->
200403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Retrieve Flows

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Retrieve Flows
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

<!--source:api-specifications-->

### Flows
<!--/source-->

`POST` `/flows`

<!--source:api-specifications-->

#### Create Flow
<!--/source-->

`createFlow`

<!--source:api-specifications-->
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.

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "type": "STATED"
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
201403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Create Flow API Triggered Successfully

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Request body`application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `type`required | `string` | <!--source:api-specifications-->Flow type<!--/source-->`SMART``STATED``VERIFIED` |

##### Response `201``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Create Flow API Triggered Successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `type` | `string` | <!--source:api-specifications-->Flow Type<!--/source-->`SMART``STATED``VERIFIED` |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

##### Other responses

`409`

`GET` `/flows/{id}`

<!--source:api-specifications-->

#### Retrieve Flow
<!--/source-->

`getFlow`

<!--source:api-specifications-->
Retrieve a specific workflow that has been created for a pre-approval application.

<!--/source-->

##### Response

<!--source:api-specifications-->
200403404
<!--/source-->

<!--source:api-specifications-->
application/json Copy Retrieve Job

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Not Found

```
{
 "value": {
 "message": "Flow not found"
 }
}
```

<!--/source-->

##### Parameters

<!--source:api-specifications-->
1
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `id` required | `string` path | `example` | <!--source:api-specifications-->Flow id<!--/source--> |

##### Response `200``application/json`

<!--source:api-specifications-->
3 fields
<!--/source-->
<!--source:api-specifications-->
Retrieve Job
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `brand_color` | `string` | <!--source:api-specifications-->Brand color<!--/source--> |
| `@id` | `string` | — |
| `@type` | `string` | — |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `404``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Not Found
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message<!--/source--> |

`GET` `/flows`

<!--source:api-specifications-->

#### Retrieve All Flows
<!--/source-->

`listFlows`

<!--source:api-specifications-->
Retrieve all existing workflows that have been created for a pre-approval application.

<!--/source-->

##### Response

<!--source:api-specifications-->
200403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Retrieve Flows

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Retrieve Flows
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

`DELETE` `/flows/{id}`

<!--source:api-specifications-->

#### Delete Flow
<!--/source-->

`deleteFlow`

<!--source:api-specifications-->
Update Flow

<!--/source-->

##### Response

<!--source:api-specifications-->
200403404
<!--/source-->

<!--source:api-specifications-->
application/json Copy Update an existing flow that has been created for a pre-approval application.

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Not Found

```
{
 "value": {
 "message": "Job not found"
 }
}
```

<!--/source-->

##### Parameters

<!--source:api-specifications-->
1
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `id` required | `string` path | `Id` | <!--source:api-specifications-->Flow id<!--/source--> |

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Update an existing flow that has been created for a pre-approval application.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Delete Result<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `404``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Not Found
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message<!--/source--> |

`PUT` `/flows/{id}`

<!--source:api-specifications-->

#### Update Flow
<!--/source-->

`updateFlow`

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "type": "STATED"
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
200403404
<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Not Found

```
{
 "value": {
 "message": "Flow not found"
 }
}
```

<!--/source-->

##### Parameters

<!--source:api-specifications-->
1
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `id` required | `string` path | `Id` | <!--source:api-specifications-->Flow id<!--/source--> |

##### Request body`application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `type`required | `string` | <!--source:api-specifications-->Flow type<!--/source-->`CLASSIFY``STATED``VERIFIED` |

##### Response `200``application/json`

<!--source:api-specifications-->
3 fields
<!--/source-->
<!--source:api-specifications-->
Update an existing flow that has been created for a pre-approval application.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `brand_color` | `string` | <!--source:api-specifications-->Brand color<!--/source--> |
| `@id` | `string` | — |
| `@type` | `string` | — |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `404``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Not Found
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error message<!--/source--> |

<!--source:api-specifications-->

### Links
<!--/source-->

`GET` `/links`

<!--source:api-specifications-->

#### Retrieve Link
<!--/source-->

`getLink`

<!--source:api-specifications-->
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.

<!--/source-->

##### Response

<!--source:api-specifications-->
200403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Retrieve Flows

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Parameters

<!--source:api-specifications-->
1
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `type` required | `string` query | `borrower_link` | <!--source:api-specifications-->Link type<!--/source--> |

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Retrieve Flows
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `type` | `string` | <!--source:api-specifications-->Flow Type<!--/source-->`SMART``STATED``VERIFIED` |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

<!--source:api-specifications-->

### Self Checks
<!--/source-->

`GET` `/self-checks`

<!--source:api-specifications-->

#### Retrieve Self Checks
<!--/source-->

`getSelfChecks`

<!--source:api-specifications-->
Retrieves all existing self-checks

<!--/source-->

##### Response

<!--source:api-specifications-->
200 GetJobResp200 application/json403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
 }
]
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Retrieve Self Checks

```
success-page
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Response `200``application/json`

<!--source:api-specifications-->
5 fields
<!--/source-->
<!--source:api-specifications-->
Retrieve Self Checks
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `job_name` | `string` | — |
| `trigger_name` | `string` | — |
| `description` | `string` | — |
| `updated_at` | `string` | — |
| `status` | `string` | `FAILED``SUCCEEDED` |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

<!--source:api-specifications-->

### Settings
<!--/source-->

`POST` `/settings`

<!--source:api-specifications-->

#### Create Settings
<!--/source-->

`createSettings`

<!--source:api-specifications-->
Create settings that describe a pre-approval application.

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "type": "brand_color"
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
201403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Create Setting API Triggered Successfully

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Request body`application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `type`required | `string` | <!--source:api-specifications-->Setting type<!--/source-->`brand_color` |

##### Response `201``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Create Setting API Triggered Successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `type` | `string` | <!--source:api-specifications-->Flow Type<!--/source-->`SMART``STATED``VERIFIED` |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

##### Other responses

`409`

`GET` `/settings`

<!--source:api-specifications-->

#### Retrieve Settings
<!--/source-->

`getSettings`

<!--source:api-specifications-->
Retrieve settings that describe a pre-approval application.

<!--/source-->

##### Response

<!--source:api-specifications-->
200403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Retrieve Flows

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Parameters

<!--source:api-specifications-->
1
<!--/source-->

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `type` | `string` query | `borrower_link` | <!--source:api-specifications-->Flow type<!--/source--> |

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Retrieve Flows
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `type` | `string` | <!--source:api-specifications-->Flow Type<!--/source-->`SMART``STATED``VERIFIED` |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

`POST` `/settings/brand_color`

<!--source:api-specifications-->

#### Brand Color Create
<!--/source-->

`createBrandColorSetting`

<!--source:api-specifications-->
Create Brand Color
<!--/source-->

<!--source:api-specifications-->
Create Brand Color Setting. You can define only HEX string.

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "brand_color": "#FFFFFF"
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
201403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Create Brand Color Triggered Successfully

```
{
 "brand_color": "#FFFFFF"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Request body`application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `brand_color`required | `string` | <!--source:api-specifications-->Brand Color<!--/source--> |

##### Response `201``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Create Brand Color Triggered Successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `brand_color`required | `string` | <!--source:api-specifications-->Brand Color<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

##### Other responses

`409`

`POST` `/settings/company_name`

<!--source:api-specifications-->

#### Company Name Create
<!--/source-->

`createCompanyNameSetting`

<!--source:api-specifications-->
Create Company Name
<!--/source-->

<!--source:api-specifications-->
Create Company Name Setting. You can define only string.

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "company_name": "Staircase"
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
201403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Create Company Name Triggered Successfully

```
{
 "company_name": "Staircase"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Request body`application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `company_name`required | `string` | <!--source:api-specifications-->Company Name<!--/source--> |

##### Response `201``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Create Company Name Triggered Successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `company_name`required | `string` | <!--source:api-specifications-->Company Name<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

##### Other responses

`409`

`PUT` `/settings`

<!--source:api-specifications-->

#### Update Setting
<!--/source-->

`updateSetting`

<!--source:api-specifications-->
Update settings that describe a pre-approval application.

<!--/source-->

##### Response

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Other responses

`204``404`

`GET` `/settings/brand_color`

<!--source:api-specifications-->

#### Brand Color Retrieve
<!--/source-->

`getBrandColorSetting`

<!--source:api-specifications-->
Retrieve Brand Color Setting
<!--/source-->

<!--source:api-specifications-->
Retrieve Brand Color

<!--/source-->

##### Response

<!--source:api-specifications-->
200403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Retrieve Brand Color

```
{
 "brand_color": "#FFFFFF"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Retrieve Brand Color
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `brand_color`required | `string` | <!--source:api-specifications-->Brand Color<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

`GET` `/settings/company_name`

<!--source:api-specifications-->

#### Company Name Retrieve
<!--/source-->

`getCompanyNameSetting`

<!--source:api-specifications-->
Retrieve Company Name Setting
<!--/source-->

<!--source:api-specifications-->
Retrieve Company Name

<!--/source-->

##### Response

<!--source:api-specifications-->
200403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Retrieve Company Name

```
{
 "company_name": "Staircase"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Retrieve Company Name
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `company_name`required | `string` | <!--source:api-specifications-->Company Name<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

`PUT` `/settings/brand_color`

<!--source:api-specifications-->

#### Brand Color Update
<!--/source-->

`updateSettingBrandColor`

<!--source:api-specifications-->
Update Brand Color Setting
<!--/source-->

<!--source:api-specifications-->
Update Brand Color

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "brand_color": "#FFFFFF"
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
application/json Copy Update Brand Color

```
{
 "brand_color": "#FFFFFF"
}
```

<!--/source-->

##### Request body`application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `brand_color`required | `string` | <!--source:api-specifications-->Brand Color<!--/source--> |

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Update Brand Color
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `brand_color`required | `string` | <!--source:api-specifications-->Brand Color<!--/source--> |

`PUT` `/settings/company_name`

<!--source:api-specifications-->

#### Company Name Update
<!--/source-->

`updateSettingCompanyName`

<!--source:api-specifications-->
Update Company Name Setting
<!--/source-->

<!--source:api-specifications-->
Update Company Name

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "company_name": "Staircase"
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
application/json Copy Update Company Name

```
{
 "company_name": "Staircase"
}
```

<!--/source-->

##### Request body`application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `company_name`required | `string` | <!--source:api-specifications-->Company Name<!--/source--> |

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Update Company Name
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `company_name`required | `string` | <!--source:api-specifications-->Company Name<!--/source--> |

`POST` `/settings/welcome_screen`

<!--source:api-specifications-->

#### Welcome Screen Create
<!--/source-->

`createWelcomeScreenSetting`

<!--source:api-specifications-->
Create Welcome Screen
<!--/source-->

<!--source:api-specifications-->
Create Welcome Screen Setting. You can define only BOOLEAN values.

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "welcome_screen": true
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
201403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Create Welcome Screen Triggered Successfully

```
{
 "welcome_screen": true
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Request body`application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `welcome_screen`required | `boolean` | <!--source:api-specifications-->Welcome Screen<!--/source--> |

##### Response `201``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Create Welcome Screen Triggered Successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `welcome_screen`required | `boolean` | <!--source:api-specifications-->Welcome Screen<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

##### Other responses

`409`

`GET` `/settings/welcome_screen`

<!--source:api-specifications-->

#### Welcome Screen Retrieve
<!--/source-->

`getWelcomeScreenSetting`

<!--source:api-specifications-->
Retrieve Welcome Screen Setting
<!--/source-->

<!--source:api-specifications-->
Retrieve Welcome Screen

<!--/source-->

##### Response

<!--source:api-specifications-->
200403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Retrieve Welcome Screen

```
{
 "welcome_screen": true
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Retrieve Welcome Screen
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `welcome_screen`required | `boolean` | <!--source:api-specifications-->Welcome Screen<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

`PUT` `/settings/welcome_screen`

<!--source:api-specifications-->

#### Welcome Screen Update
<!--/source-->

`updateWelcomeScreenColor`

<!--source:api-specifications-->
Update Welcome Screen Setting
<!--/source-->

<!--source:api-specifications-->
Update Welcome Screen

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "welcome_screen": true
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
application/json Copy Update Welcome Screen

```
{
 "welcome_screen": true
}
```

<!--/source-->

##### Request body`application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `welcome_screen`required | `boolean` | <!--source:api-specifications-->Welcome Screen<!--/source--> |

##### Response `200``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Update Welcome Screen
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `welcome_screen`required | `boolean` | <!--source:api-specifications-->Welcome Screen<!--/source--> |

`PUT` `/settings/logo`

<!--source:api-specifications-->

#### Upload logo
<!--/source-->

`UploadLogo`

<!--source:api-specifications-->
Upload Logo
<!--/source-->

<!--source:api-specifications-->
Upload logo: Uploads company logo for Nav Bar

<!--/source-->

##### Request

<!--source:api-specifications-->
multipart/form-data Copy Upload new logo

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

<!--/source-->

##### Response

<!--source:api-specifications-->
201403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Upload New Logo Triggered Successfully

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy 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"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error

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

<!--/source-->

##### Request body`multipart/form-data`

<!--source:api-specifications-->
1 fields
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `image` | `string (binary)` | <!--source:api-specifications-->Image to upload<!--/source--> |

##### Response `201``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Upload New Logo Triggered Successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `status` | `string` | <!--source:api-specifications-->Status process<!--/source--> |
| `blob_id` | `string` | <!--source:api-specifications-->Image Blob ID<!--/source--> |

##### Response `403``application/json`

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `500``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Error Message<!--/source--> |

##### Other responses

`409`

## Errors

`403``404``409``500`

## More in Automation

- Next product: Boarding