<!-- https://staircase.co/agents/roster/frequently-asked-questions -->
# Frequently-asked questions

# Frequently-asked questions

Products

<!--source:agent-kits-->
Answers a borrower's questions from a curated knowledge base rather than from the model's general knowledge, with the source behind each answer.
<!--/source-->

- **Used when**
<!--source:agent-kits-->
— At any point in the conversation, alongside whichever subject is open.
<!--/source-->

- **Collects**
<!--source:agent-kits-->
- The question, and the subject it was asked from.
<!--/source-->

- **Returns**
<!--source:agent-kits-->
- The answer, and the document it came from.
<!--/source-->
<!--source:agent-kits-->
- The question itself, recorded, so an unanswered one becomes a knowledge-base gap.
<!--/source-->

- **Evidence**
- `bot-faq-support`
- `chatbot-knowledge-update`

## Operations

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

### FAQ bot service
<!--/source-->

`GET` `/`

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

#### Get Bot Knowledge
<!--/source-->

`getKnowledge`

<!--source:api-specifications-->
Get knowledge of faq bot
<!--/source-->

<!--source:api-specifications-->
Get extra bot knowledge

<!--/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--> |

##### Response `503``application/json`

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

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

##### Other responses

`200`

`POST` `/`

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

#### Update Bot Knowledge
<!--/source-->

`updateBotKnowledge`

<!--source:api-specifications-->
Update knowledge
<!--/source-->

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

<!--/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 `400``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Bad Request
<!--/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--> |

##### Response `503``application/json`

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

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

##### Other responses

`200`

`DELETE` `/{knowledge_id}`

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

#### Delete Bot Knowledge
<!--/source-->

`deleteKnowledge`

<!--source:api-specifications-->
Delete extra knowledge
<!--/source-->

<!--source:api-specifications-->
Delete extra bot knowdlege from faq-bot-service

<!--/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-->

##### Parameters

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `knowledge_id` required | `string` path | `id_knowledge` | <!--source:api-specifications-->Knowledge id<!--/source--> |

##### Response `400``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Bad Request
<!--/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--> |

##### Response `503``application/json`

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

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

##### Other responses

`204`

`POST` `/slab`

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

#### Update Bot Knowledge Slab
<!--/source-->

`updateBotKnowledgeSlab`

<!--source:api-specifications-->
Update knowledge
<!--/source-->

<!--source:api-specifications-->
Slab webhook for updating bot knowledge

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "type": "post_update",
 "post": {
 "id": "elaykynn",
 "title": "Neuromancer",
 "link_access": "internal",
 "state": "published",
 "version": 1,
 "bannerUrl": null
 },
 "old_post": {
 "state": "archived",
 "link_access": "internal",
 "bannerUrl": null,
 "ownerId": "l7ibj9w0",
 "archiverId": "l7ibj9w0",
 "publisherId": "l7ibj9w0",
 "seriesId": null
 },
 "archiver": null,
 "owner": {
 "id": "l7ibj9w0",
 "name": "William Gibson"
 },
 "publisher": {
 "id": "l7ibj9w0",
 "name": "William Gibson"
 },
 "series": null
}
```

<!--/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--> |

##### Response `503``application/json`

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

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

##### Other responses

`200`

`POST` `/sync`

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

#### Sync Bot Knowledge
<!--/source-->

`syncBotKnowledgeSlab`

<!--source:api-specifications-->
Sync knowledge
<!--/source-->

<!--source:api-specifications-->
Slab webhook for updating bot knowledge from Slab and knowledge database

<!--/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--> |

##### Response `503``application/json`

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

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

##### Other responses

`200`

## Others in Products

- Application document
- Assets
- Co-borrower invitation
- Contact details
- Correction
- Credit
- Declarations
- Demographic details
- Employment and income
- Gifts and grants
- Liabilities
- Loan lookup
- Military service
- Mortgage details
- Other income
- Personal identity
- Preapproval letter
- Pricing
- Rate estimate
- Real estate owned
- Residency
- Self-employment income
- Workspace assistant