<!-- https://staircase.co/products/verification/identity -->
# Identity

# Identity

Identity verification and fraud checks run before the rest of an application proceeds.

A caller sends the identity claims collected from a borrower — name, date of birth, address history, and a government identifier — and receives a verified or unverified result with the reasons behind it.

It gates the products after it. An application that cannot establish who the borrower is has nothing useful to verify, so identity runs first in every flow that composes these products.

## How it works

Two vendor types sit behind it: a phone-and-carrier signal check and a bureau identity product. They answer different questions — one is possession of a device tied to an identity, the other is the existence and consistency of a credit-file identity — and the canonical response carries both rather than collapsing them to a single score.

## Operations

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

### Setup
<!--/source-->

`PUT` `/connector-jobs/vendors/prove/passed-credentials`

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

#### Set Prove Credentials
<!--/source-->

`setProveCredentials`

<!--source:api-specifications-->
By using Set Prove Credentials API we allow our customers to configure custom instance in customer environment. If you want to use your own instance for verification operations, run Set Credentials API.

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "host": "https://api.staging.payfone.com",
 "username": "d3e28e0e-a4f9-490b-af32-a4001101ce3b",
 "password": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```

<!--/source-->

##### Response

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

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

```
{
 "message": "Credentials are saved and verified"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Request data failed validation

```
{
 "code": 400,
 "message": "Bad Request"
}
```

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

```
{
 "code": 422,
 "message": "Unprocessed Entity."
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support."
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Environment API Key.<!--/source--> |

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

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

| Field | Type | Description |
| --- | --- | --- |
| `host`required | `string` | <!--source:api-specifications-->Prove host<!--/source--> |
| `username`required | `string` | <!--source:api-specifications-->Prove username<!--/source--> |
| `password`required | `string` | <!--source:api-specifications-->Prove password<!--/source--> |

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

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

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Request data failed validation
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | <!--source:api-specifications-->Unprocessed entity error.<!--/source--> |
| `code`required | `string` | <!--source:api-specifications-->Error name.<!--/source--> |
| `message`required | `string` | <!--source:api-specifications-->Error description.<!--/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-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `422``application/json`

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

| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | <!--source:api-specifications-->Unprocessed entity error.<!--/source--> |
| `code`required | `string` | <!--source:api-specifications-->Error name.<!--/source--> |
| `message`required | `string` | <!--source:api-specifications-->Error description.<!--/source--> |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.
<!--/source-->

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

`POST` `/setup/dytrix/credentials`

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

#### Set Dytrix Credentials
<!--/source-->

`setDytrixCredentials`

<!--source:api-specifications-->
By using Set Dytrix Credentials API we allow our customers to configure Dytrix in customer environment.

If you want to use your own Dytrix contract for verification, please check Request body Schema example for required values from partner side and run Set Dytrix Credentials API.

You can check the partner status by calling the Retrieve Partners endpoint

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "base_url": "https://api.dytrix.com",
 "username": "--------",
 "password": "<redacted>",
 "credentials_type": "test"
}
```

<!--/source-->

##### Response

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

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

```
{
 "message": "Credentials are saved and verified"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Request data failed validation

```
{
 "message": "{'data': ['Missing data for required field.']}"
}
```

<!--/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 Request data failed validation

```
{
 "message": "{'data': ['Missing data for required field.']}"
}
```

<!--/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 |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Staircase Environment API Key<!--/source--> |

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

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

| Field | Type | Description |
| --- | --- | --- |
| `base_url`required | `string` | <!--source:api-specifications-->Base URL for Dytrix API<!--/source--> |
| `username`required | `string` | <!--source:api-specifications-->Dytrix username<!--/source--> |
| `password`required | `string` | <!--source:api-specifications-->Dytrix password<!--/source--> |
| `credentials_type`required | `string` | <!--source:api-specifications-->Type of credentials, can be either test or production<!--/source--> |

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

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

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Request data failed validation
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->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 `422``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Request data failed validation
<!--/source-->

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

##### 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

`404`

`GET` `/setup/{partner_name}/credentials`

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

#### Retrieve Partner Credentials Schema
<!--/source-->

`getCredentials`

<!--source:api-specifications-->
Get Credentials Schema
<!--/source-->

<!--source:api-specifications-->
Get credentials schema for specific partner. You can use retrieved schema for setting the partner credentials.

<!--/source-->

##### Response

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

<!--source:api-specifications-->
application/json Copy Request data failed validation

```
{
 "message": "{'data': ['Missing data for required field.']}"
}
```

<!--/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 Request data failed validation

```
{
 "message": "{'data': ['Missing data for required field.']}"
}
```

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Staircase Environment API Key<!--/source--> |
| `partner_name` required | `string` path | `dytrix` | <!--source:api-specifications-->Partner name<!--/source--> |

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

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

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Request data failed validation
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->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 `422``application/json`

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Request data failed validation
<!--/source-->

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

##### 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

`404`

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

### Workflow
<!--/source-->

`POST` `/identity/verification`

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

#### Verify Phone Number
<!--/source-->

`verifyPhoneNumber`

<!--source:api-specifications-->
By using Verify Phone Number API we allow our customers to verify the phone number. Before executing this operation need to execute Set Prove Credentials API and enable static IP feature in network settings.

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "partner_name": "Prove",
 "request_data": {
 "people": [
 {
 "first_name": "Tod",
 "last_name": "Weedall",
 "phone_number": "2001001686",
 "birth_date": "1984-12-10"
 }
 ]
 }
}
```

<!--/source-->

##### Response

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

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

```
{
 "id": "01H1WE08FGKNX0PKNZ88AKNTBX"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Request data failed validation

```
{
 "code": 400,
 "message": "Bad Request"
}
```

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

```
{
 "code": 422,
 "message": "Unprocessed Entity."
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support."
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Environment API Key.<!--/source--> |
| `content-type` required | `string` header | `application/json` | <!--source:api-specifications-->Content Type.<!--/source--> |

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

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

| Field | Type | Description |
| --- | --- | --- |
| `partner_name`required | `string` | <!--source:api-specifications-->Partner name<!--/source--> |
| `people` | `object[]` | <!--source:api-specifications-->People for verification<!--/source--> |
| `first_name` | `string` | <!--source:api-specifications-->First name<!--/source--> |
| `last_name` | `string` | <!--source:api-specifications-->Last name<!--/source--> |
| `phone_number` | `string` | <!--source:api-specifications-->Phone number<!--/source--> |
| `birth_date` | `string` | <!--source:api-specifications-->Birthdate<!--/source--> |

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

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

| Field | Type | Description |
| --- | --- | --- |
| `id` | `string` | <!--source:api-specifications-->Execution identifier<!--/source--> |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Request data failed validation
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | <!--source:api-specifications-->Unprocessed entity error.<!--/source--> |
| `code`required | `string` | <!--source:api-specifications-->Error name.<!--/source--> |
| `message`required | `string` | <!--source:api-specifications-->Error description.<!--/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-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `422``application/json`

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

| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | <!--source:api-specifications-->Unprocessed entity error.<!--/source--> |
| `code`required | `string` | <!--source:api-specifications-->Error name.<!--/source--> |
| `message`required | `string` | <!--source:api-specifications-->Error description.<!--/source--> |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.
<!--/source-->

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

`POST` `/products/identity/invocations`

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

#### Verify Identity
<!--/source-->

`invokeProductFlow`

<!--source:api-specifications-->
This endpoint creates an identity verification request for the provided transaction, collection and selected partner

#### Usage

You can send a request in two different ways:

- Using `transaction_id` and `request_collection_id`: If you already have a request collection, you can provide its details using these two parameters. Note that in this case Response Collection would be created in the provided Transaction.
- Using `request_data`: If you provide this parameter, flow invocation would use the data here as input. If you also provide a `transaction_id` in the request body, Response Collection would be created in the related Transaction object. If you don't provide a `transaction_id` we will automatically create a Transaction for you and Response Collection would be created in this new Transaction as well.

Note: You cannot provide `product_flow_name` and `vendor_name` parameters together. When provided together, simply `product_flow_name` is used.

Show the rest

#### Verification options

- If you are already familiar with agent details, the get-report flow can be executed.
- If you are not familiar with agent details, search-agent flow can be used to search for it.
- If you are not able to find an agent you can either request to add a company (add-company flow) or request to add a branch to the existing company (add-branch flow).

##### get-report

You can use get-report flow to get Identity verification documents (Closing Agent Report, Insurance reports and Wire Instruction reports). Mandatory request fields are:

- AgentId
- BorrowersName
- FullPropertyAddress
- LoanId
- EstClosingDate

##### search-agent

You can use search-agent flow to search for available agents. The only mandatory field is the CompanyName, and it has to have at least 3 or more characters.

##### add-company

If the agent you want to use is not in the list, you can request to add the company. Mandatory request fields are:

- AgentName
- ContactFirstName
- ContactLastName
- Email
- Phone
- Address1
- City
- State
- ZipCode
- BorrowersName
- FullPropertyAddress
- LoanId
- EstClosingDate

##### add-branch

If the agent you want to use is on the list, but there is no matching branch (location), you can request to add the branch to the existing company. Mandatory request fields are:

- AgentId
- CompanyName
- ContactFirstName
- ContactLastName
- Email
- Phone
- Address1
- City
- State
- ZipCode
- BorrowersName
- FullPropertyAddress
- LoanId
- EstClosingDate

##### get-request-status

You can use get-request-status flow to get the partner's request status for add-company, add-branch, add-wire, suspend-agent-update and update-agent-info flows. Mandatory field is RequestId. You can retrieve mentioned RequestId as a part of a response of all previously mentioned flows.

##### add-wire

You can use add-wire flow to get the wire number verification. Mandatory request fields are:

- AgentId
- BorrowersName
- FullPropertyAddress
- LoanId
- EstClosingDate
- ContactFirstName
- ContactLastName
- Email
- Phone

##### suspend-agent-update

You can use suspend-agent-update flow if the agent is not yet qualified, or it has documents that have expired recently. Mandatory request fields are:

- AgentId
- BorrowersName
- FullPropertyAddress
- LoanId
- EstClosingDate
- ContactFirstName
- ContactLastName
- Email
- Phone

##### cancel-request

You can use cancel-request flow to cancel any of the requests (add-company, add-branch, add-wire, suspend-agent-update or update-agent-info) made. Mandatory request fields are:

- RequestId
- Reason

##### update-agent-info

You can use update-agent-info flow if the agent's insurance or license dates are expired or non-existing. You can also use the mentioned flow if the agent qualification is still pending review. Mandatory request fields are:

- AgentId
- RequestPurpose
- BorrowersName
- FullPropertyAddress
- LoanId
- EstClosingDate
- ContactFirstName
- ContactLastName
- Email
- Phone

#### Retrieving the Invocation Result

After flow invocation, endpoint returns an `invocation_id` which you can poll for its status using /products/identity/invocations/{invocation_id} endpoint. Once the invocation is completed, the Response Collection is populated with results.

If you would rather receive a callback once the invocation is completed instead of polling it, you can set the `callback_url` parameter in the request body.

<!--/source-->

##### Request

<!--source:api-specifications-->
get-reportsearch-agentadd-companyadd-branchget-request-statusadd-wiresuspend-agent-updatecancel-requestupdate-agent-info
<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "product_flow_name": "get-report",
 "request_data": {
 "people": [
 {
 "@type": "appraiser",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA01",
 "has_first_name": {
 "has_value": "Joe"
 },
 "has_last_name": {
 "has_value": "Doe"
 },
 "contact_at": [
 "01FD6ZNGJADZ0RB1H96FSEAA02"
 ]
 },
 {
 "@type": "borrower",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA20",
 "has_full_name": {
 "has_value": "John Smith"
 }
 }
 ],
 "contact_information": [
 {
 "@type": "contact_information",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA02",
 "has_email_address": {
 "has_value": "appraiser@appraiser.com"
 },
 "has_phone_number": {
 "has_value": "+14086002581"
 }
 }
 ],
 "organizations": [
 {
 "@type": "agent_branch",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA03",
 "has_organization_identifier": {
 "has_value": "123"
 }
 }
 ],
 "addresses": [
 {
 "@type": "address",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA06",
 "has_full_address_text": {
 "has_value": "57 Berry Lane, Bldg 12, Apt # 22 New York, NY, 10014"
 },
 "has_state_code": {
 "has_value": "NY"
 }
 }
 ],
 "property": [
 {
 "@type": "property",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA05",
 "with_address": [
 "01FD6ZNGJADZ0RB1H96FSEAA06"
 ]
 }
 ],
 "loans": [
 {
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA07",
 "@type": "loan",
 "has_loan_identifier_value": {
 "has_value": "123456"
 },
 "has_loan_purpose_type": {
 "has_value": "1"
 },
 "has_loan_amount": {
 "has_value": "50000.55"
 },
 "has_loan_estimated_closing_date": {
 "has_value": "05/12/2020"
 }
 }
 ],
 "comment": [
 {
 "@type": "comment",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA08",
 "has_comment": {
 "has_value": "This is comment."
 }
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "product_flow_name": "search-agent",
 "request_data": {
 "people": [
 {
 "@type": "appraiser",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA01",
 "has_first_name": {
 "has_value": "Joe"
 },
 "has_last_name": {
 "has_value": "Doe"
 },
 "contact_at": [
 "01FD6ZNGJADZ0RB1H96FSEAA02"
 ]
 }
 ],
 "contact_information": [
 {
 "@type": "contact_information",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA02",
 "has_email_address": {
 "has_value": "appraiser@appraiser.com"
 },
 "has_phone_number": {
 "has_value": "+14086002581"
 }
 }
 ],
 "organizations": [
 {
 "@type": "agent_branch",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA03",
 "has_organization_name": {
 "has_value": "ACME Inc."
 },
 "with_address": [
 "01FD6ZNGJADZ0RB1H96FSEAA04"
 ]
 }
 ],
 "addresses": [
 {
 "@type": "address",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA04",
 "has_address_line_1_text": {
 "has_value": "57 Berry Lane"
 },
 "has_address_line_2_text": {
 "has_value": "Bldg 12, Apt # 22"
 },
 "has_city_name": {
 "has_value": "New York"
 },
 "has_state_code": {
 "has_value": "NY"
 },
 "has_postal_code": {
 "has_value": "10014"
 }
 },
 {
 "@type": "address",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA06",
 "has_state_code": {
 "has_value": "PA"
 }
 }
 ],
 "property": [
 {
 "@type": "property",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA05",
 "with_address": [
 "01FD6ZNGJADZ0RB1H96FSEAA06"
 ]
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "product_flow_name": "add-company",
 "request_data": {
 "people": [
 {
 "@type": "appraiser",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA01",
 "has_first_name": {
 "has_value": "Joe"
 },
 "has_last_name": {
 "has_value": "Doe"
 },
 "contact_at": [
 "01FD6ZNGJADZ0RB1H96FSEAA02"
 ]
 },
 {
 "@type": "contact",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA31",
 "has_first_name": {
 "has_value": "Jane"
 },
 "has_last_name": {
 "has_value": "Smith"
 },
 "contact_at": [
 "01FD6ZNGJADZ0RB1H96FSEAA32"
 ]
 },
 {
 "@type": "borrower",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA20",
 "has_full_name": {
 "has_value": "John Smith"
 }
 }
 ],
 "contact_information": [
 {
 "@type": "contact_information",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA02",
 "has_email_address": {
 "has_value": "appraiser@appraiser.com"
 },
 "has_phone_number": {
 "has_value": "+14086002581"
 }
 },
 {
 "@type": "contact_information",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA32",
 "has_email_address": {
 "has_value": "contact@contact.com"
 },
 "has_phone_number": {
 "has_value": "+14086002582"
 }
 }
 ],
 "organizations": [
 {
 "@type": "agent_branch",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA03",
 "has_organization_name": {
 "has_value": "ACME Inc."
 },
 "with_address": [
 "01FD6ZNGJADZ0RB1H96FSEAA33"
 ]
 }
 ],
 "addresses": [
 {
 "@type": "address",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA33",
 "has_address_line_1_text": {
 "has_value": "57 Berry Lane"
 },
 "has_address_line_2_text": {
 "has_value": "Bldg 12, Apt # 22"
 },
 "has_city_name": {
 "has_value": "New York"
 },
 "has_state_code": {
 "has_value": "NY"
 },
 "has_postal_code": {
 "has_value": "10014"
 }
 },
 {
 "@type": "address",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA06",
 "has_full_address_text": {
 "has_value": "57 Berry Lane, Bldg 12, Apt # 22 New York, NY, 10014"
 }
 }
 ],
 "property": [
 {
 "@type": "property",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA05",
 "with_address": [
 "01FD6ZNGJADZ0RB1H96FSEAA06"
 ]
 }
 ],
 "loans": [
 {
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA07",
 "@type": "loan",
 "has_loan_identifier_value": {
 "has_value": "123456"
 },
 "has_loan_purpose_type": {
 "has_value": "1"
 },
 "has_loan_amount": {
 "has_value": "50000.55"
 },
 "has_loan_estimated_closing_date": {
 "has_value": "05/12/2020"
 }
 }
 ],
 "comment": [
 {
 "@type": "comment",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA08",
 "has_comment": {
 "has_value": "This is comment."
 }
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "product_flow_name": "add-branch",
 "request_data": {
 "people": [
 {
 "@type": "appraiser",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA01",
 "has_first_name": {
 "has_value": "Joe"
 },
 "has_last_name": {
 "has_value": "Doe"
 },
 "contact_at": [
 "01FD6ZNGJADZ0RB1H96FSEAA02"
 ]
 },
 {
 "@type": "contact",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA31",
 "has_first_name": {
 "has_value": "Jane"
 },
 "has_last_name": {
 "has_value": "Smith"
 },
 "contact_at": [
 "01FD6ZNGJADZ0RB1H96FSEAA32"
 ]
 },
 {
 "@type": "borrower",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA20",
 "has_full_name": {
 "has_value": "John Smith"
 }
 }
 ],
 "contact_information": [
 {
 "@type": "contact_information",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA02",
 "has_email_address": {
 "has_value": "appraiser@appraiser.com"
 },
 "has_phone_number": {
 "has_value": "+14086002581"
 }
 },
 {
 "@type": "contact_information",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA32",
 "has_email_address": {
 "has_value": "contact@contact.com"
 },
 "has_phone_number": {
 "has_value": "+14086002582"
 }
 }
 ],
 "organizations": [
 {
 "@type": "agent",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA40",
 "has_organization_identifier": {
 "has_value": "123"
 }
 },
 {
 "@type": "agent_branch",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA03",
 "has_organization_name": {
 "has_value": "ACME Inc."
 },
 "with_address": [
 "01FD6ZNGJADZ0RB1H96FSEAA33"
 ]
 }
 ],
 "addresses": [
 {
 "@type": "address",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA33",
 "has_address_line_1_text": {
 "has_value": "57 Berry Lane"
 },
 "has_address_line_2_text": {
 "has_value": "Bldg 12, Apt # 22"
 },
 "has_city_name": {
 "has_value": "New York"
 },
 "has_state_code": {
 "has_value": "NY"
 },
 "has_postal_code": {
 "has_value": "10014"
 }
 },
 {
 "@type": "address",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA06",
 "has_full_address_text": {
 "has_value": "57 Berry Lane, Bldg 12, Apt # 22 New York, NY, 10014"
 }
 }
 ],
 "property": [
 {
 "@type": "property",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA05",
 "with_address": [
 "01FD6ZNGJADZ0RB1H96FSEAA06"
 ]
 }
 ],
 "loans": [
 {
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA07",
 "@type": "loan",
 "has_loan_identifier_value": {
 "has_value": "123456"
 },
 "has_loan_purpose_type": {
 "has_value": "1"
 },
 "has_loan_amount": {
 "has_value": "50000.55"
 },
 "has_loan_estimated_closing_date": {
 "has_value": "05/12/2020"
 }
 }
 ],
 "comment": [
 {
 "@type": "comment",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA08",
 "has_comment": {
 "has_value": "This is comment."
 }
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "product_flow_name": "get-request-status",
 "request_data": {
 "people": [
 {
 "@type": "appraiser",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA01",
 "has_first_name": {
 "has_value": "Joe"
 },
 "has_last_name": {
 "has_value": "Doe"
 },
 "contact_at": [
 "01FD6ZNGJADZ0RB1H96FSEAA02"
 ]
 }
 ],
 "contact_information": [
 {
 "@type": "contact_information",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA02",
 "has_email_address": {
 "has_value": "appraiser@appraiser.com"
 },
 "has_phone_number": {
 "has_value": "+14086002581"
 }
 }
 ],
 "customer_request": [
 {
 "@type": "customer_request",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA40",
 "has_customer_request_identifier": {
 "has_value": "12345"
 }
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "product_flow_name": "add-wire",
 "request_data": {
 "people": [
 {
 "@type": "appraiser",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA01",
 "has_first_name": {
 "has_value": "Joe"
 },
 "has_last_name": {
 "has_value": "Doe"
 },
 "contact_at": [
 "01FD6ZNGJADZ0RB1H96FSEAA02"
 ]
 },
 {
 "@type": "contact",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA31",
 "has_first_name": {
 "has_value": "Jane"
 },
 "has_last_name": {
 "has_value": "Smith"
 },
 "contact_at": [
 "01FD6ZNGJADZ0RB1H96FSEAA32"
 ]
 },
 {
 "@type": "borrower",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA20",
 "has_full_name": {
 "has_value": "John Smith"
 }
 }
 ],
 "contact_information": [
 {
 "@type": "contact_information",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA02",
 "has_email_address": {
 "has_value": "appraiser@appraiser.com"
 },
 "has_phone_number": {
 "has_value": "+14086002581"
 }
 },
 {
 "@type": "contact_information",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA32",
 "has_email_address": {
 "has_value": "contact@contact.com"
 },
 "has_phone_number": {
 "has_value": "+14086002582"
 }
 }
 ],
 "organizations": [
 {
 "@type": "agent_branch",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA03",
 "has_organization_identifier": {
 "has_value": "123"
 }
 }
 ],
 "addresses": [
 {
 "@type": "address",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA06",
 "has_full_address_text": {
 "has_value": "57 Berry Lane, Bldg 12, Apt # 22 New York, NY, 10014"
 }
 }
 ],
 "property": [
 {
 "@type": "property",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA05",
 "with_address": [
 "01FD6ZNGJADZ0RB1H96FSEAA06"
 ]
 }
 ],
 "loans": [
 {
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA07",
 "@type": "loan",
 "has_loan_identifier_value": {
 "has_value": "123456"
 },
 "has_loan_purpose_type": {
 "has_value": "1"
 },
 "has_loan_amount": {
 "has_value": "50000.55"
 },
 "has_loan_estimated_closing_date": {
 "has_value": "05/12/2020"
 }
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "product_flow_name": "suspend-agent-update",
 "request_data": {
 "people": [
 {
 "@type": "appraiser",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA01",
 "has_first_name": {
 "has_value": "Joe"
 },
 "has_last_name": {
 "has_value": "Doe"
 },
 "contact_at": [
 "01FD6ZNGJADZ0RB1H96FSEAA02"
 ]
 },
 {
 "@type": "contact",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA31",
 "has_first_name": {
 "has_value": "Jane"
 },
 "has_last_name": {
 "has_value": "Smith"
 },
 "contact_at": [
 "01FD6ZNGJADZ0RB1H96FSEAA32"
 ]
 },
 {
 "@type": "borrower",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA20",
 "has_full_name": {
 "has_value": "John Smith"
 }
 }
 ],
 "contact_information": [
 {
 "@type": "contact_information",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA02",
 "has_email_address": {
 "has_value": "appraiser@appraiser.com"
 },
 "has_phone_number": {
 "has_value": "+14086002581"
 }
 },
 {
 "@type": "contact_information",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA32",
 "has_email_address": {
 "has_value": "contact@contact.com"
 },
 "has_phone_number": {
 "has_value": "+14086002582"
 }
 }
 ],
 "organizations": [
 {
 "@type": "agent_branch",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA03",
 "has_organization_identifier": {
 "has_value": "123"
 }
 }
 ],
 "addresses": [
 {
 "@type": "address",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA06",
 "has_full_address_text": {
 "has_value": "57 Berry Lane, Bldg 12, Apt # 22 New York, NY, 10014"
 }
 }
 ],
 "property": [
 {
 "@type": "property",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA05",
 "with_address": [
 "01FD6ZNGJADZ0RB1H96FSEAA06"
 ]
 }
 ],
 "loans": [
 {
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA07",
 "@type": "loan",
 "has_loan_identifier_value": {
 "has_value": "123456"
 },
 "has_loan_purpose_type": {
 "has_value": "1"
 },
 "has_loan_amount": {
 "has_value": "50000.55"
 },
 "has_loan_estimated_closing_date": {
 "has_value": "05/12/2020"
 }
 }
 ],
 "comment": [
 {
 "@type": "comment",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA08",
 "has_comment": {
 "has_value": "This is comment."
 }
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "product_flow_name": "cancel-request",
 "request_data": {
 "people": [
 {
 "@type": "appraiser",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA01",
 "has_first_name": {
 "has_value": "Joe"
 },
 "has_last_name": {
 "has_value": "Doe"
 },
 "contact_at": [
 "01FD6ZNGJADZ0RB1H96FSEAA02"
 ]
 }
 ],
 "contact_information": [
 {
 "@type": "contact_information",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA02",
 "has_email_address": {
 "has_value": "appraiser@appraiser.com"
 },
 "has_phone_number": {
 "has_value": "+14086002581"
 }
 }
 ],
 "customer_request": [
 {
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA13",
 "@type": "customer_request",
 "has_customer_request_identifier": {
 "has_value": "CR12"
 }
 }
 ],
 "comment": [
 {
 "@type": "comment",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA08",
 "has_comment": {
 "has_value": "This is a reason."
 }
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy
```
{
 "product_flow_name": "update-agent-info",
 "request_data": {
 "people": [
 {
 "@type": "appraiser",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA01",
 "has_first_name": {
 "has_value": "Joe"
 },
 "has_last_name": {
 "has_value": "Doe"
 },
 "contact_at": [
 "01FD6ZNGJADZ0RB1H96FSEAA02"
 ]
 },
 {
 "@type": "contact",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA31",
 "has_first_name": {
 "has_value": "Jane"
 },
 "has_last_name": {
 "has_value": "Smith"
 },
 "contact_at": [
 "01FD6ZNGJADZ0RB1H96FSEAA32"
 ]
 },
 {
 "@type": "borrower",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA20",
 "has_full_name": {
 "has_value": "John Smith"
 }
 }
 ],
 "contact_information": [
 {
 "@type": "contact_information",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA02",
 "has_email_address": {
 "has_value": "appraiser@appraiser.com"
 },
 "has_phone_number": {
 "has_value": "+14086002581"
 }
 },
 {
 "@type": "contact_information",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA32",
 "has_email_address": {
 "has_value": "contact@contact.com"
 },
 "has_phone_number": {
 "has_value": "+14086002582"
 }
 }
 ],
 "organizations": [
 {
 "@type": "agent_branch",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA03",
 "has_organization_identifier": {
 "has_value": "123"
 }
 }
 ],
 "addresses": [
 {
 "@type": "address",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA06",
 "has_full_address_text": {
 "has_value": "57 Berry Lane, Bldg 12, Apt # 22 New York, NY, 10014"
 }
 }
 ],
 "property": [
 {
 "@type": "property",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA05",
 "with_address": [
 "01FD6ZNGJADZ0RB1H96FSEAA06"
 ]
 }
 ],
 "loans": [
 {
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA07",
 "@type": "loan",
 "has_loan_identifier_value": {
 "has_value": "123456"
 },
 "has_loan_purpose_type": {
 "has_value": "1"
 },
 "has_loan_amount": {
 "has_value": "50000.55"
 },
 "has_loan_estimated_closing_date": {
 "has_value": "05/12/2020"
 }
 }
 ],
 "comment": [
 {
 "@type": "comment",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA08",
 "has_comment": {
 "has_value": "This is comment."
 }
 }
 ],
 "customer_request": [
 {
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA13",
 "@type": "customer_request",
 "has_customer_request_type": {
 "has_value": "CRT12"
 }
 }
 ]
 }
}
```

<!--/source-->

##### Response

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

<!--source:api-specifications-->
application/json Copy Successfully started flow invocation.

```
{
 "product_flow_name": "search-agent",
 "metadata": {},
 "request_collection_id": "01GG6ZWKQM5TEE7ZCSWK78WFHZ",
 "response_collection_id": "01GG6ZWKSD1C5363SKB0J9DVMQ",
 "invocation_mode": "single_flow",
 "widget_url": "",
 "invocation_id": "e0280760-f674-44bc-a2d8-1a67e5480da8",
 "invocation_status": "STARTED",
 "transaction_id": "01GG6ZWKE0FHMPZGVWPPM27S08",
 "request_data": {
 "people": [
 {
 "@type": "appraiser",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA01",
 "has_first_name": {
 "has_value": "Joe"
 },
 "has_last_name": {
 "has_value": "Doe"
 },
 "contact_at": [
 "01FD6ZNGJADZ0RB1H96FSEAA02"
 ]
 }
 ],
 "contact_information": [
 {
 "@type": "contact_information",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA02",
 "has_email_address": {
 "has_value": "appraiser@appraiser.com"
 },
 "has_phone_number": {
 "has_value": "+14086002581"
 }
 }
 ],
 "organizations": [
 {
 "@type": "agent_branch",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA03",
 "has_organization_name": {
 "has_value": "ACME Inc."
 },
 "with_address": [
 "01FD6ZNGJADZ0RB1H96FSEAA04"
 ]
 }
 ],
 "addresses": [
 {
 "@type": "address",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA04",
 "has_address_line_1_text": {
 "has_value": "57 Berry Lane"
 },
 "has_address_line_2_text": {
 "has_value": "Bldg 12, Apt # 22"
 },
 "has_city_name": {
 "has_value": "New York"
 },
 "has_state_code": {
 "has_value": "NY"
 },
 "has_postal_code": {
 "has_value": "10014"
 }
 },
 {
 "@type": "address",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA06",
 "has_state_code": {
 "has_value": "PA"
 }
 }
 ],
 "property": [
 {
 "@type": "property",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA05",
 "with_address": [
 "01FD6ZNGJADZ0RB1H96FSEAA06"
 ]
 }
 ]
 },
 "_links": {
 "health_metrics": "https://staircase-environment.staircaseapi.com/code-health-checker/metric/01GG6ZWKE0FHMPZGVWPPM27S08?product_name=identity"
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Request data failed validation

```
{
 "message": "{'data': ['Missing data for required field.']}"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 403 invalid error

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

<!--/source-->

<!--source:api-specifications-->
text/html Copy Resource not found

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400 Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support"
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Environment API Key.<!--/source--> |

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

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

| Field | Type | Description |
| --- | --- | --- |
| `product_flow_name` | `string` | <!--source:api-specifications-->Product flow name. If it is not specified, the default product flow will be invoked. If the product has no default product flow, the first created flow will be invoked. Cannot be specified together with vendor_name.<!--/source--> |
| `vendor_name` | `string` | <!--source:api-specifications-->Vendor name. Cannot be specified together with product_flow_name.<!--/source--> |
| `transaction_id` | `string` | <!--source:api-specifications-->Transaction ID used for invocation.<!--/source--> |
| `request_collection_id` | `string` | <!--source:api-specifications-->Request Collection ID.<!--/source--> |
| `response_collection_id` | `string` | <!--source:api-specifications-->Response Collection ID.<!--/source--> |
| `callback_url` | `string (uri)` | <!--source:api-specifications-->Callback URL.<!--/source--> |
| `request_data` | `object` | <!--source:api-specifications-->Request JSON body.<!--/source--> |
| `tags` | `string[]` | <!--source:api-specifications-->List of tags.<!--/source--> |
| `options` | `object` | <!--source:api-specifications-->Additional information that should be passed to the connector but not be added to the request collection.<!--/source--> |
| `invocation_mode` | `string` | <!--source:api-specifications-->The invocation mode of a product flow single_flow or waterfall, default value single_flow<!--/source--> |

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

<!--source:api-specifications-->
11 fields
<!--/source-->
<!--source:api-specifications-->
Successfully started flow invocation.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `product_flow_name` | `string` | <!--source:api-specifications-->Product flow name.<!--/source--> |
| `metadata` | `object` | <!--source:api-specifications-->The metadata of the invoked product flow.<!--/source--> |
| `request_collection_id` | `string` | <!--source:api-specifications-->Request collection ID.<!--/source--> |
| `response_collection_id` | `string` | <!--source:api-specifications-->Response collection ID.<!--/source--> |
| `invocation_mode` | `string` | <!--source:api-specifications-->Invocation flow.<!--/source--> |
| `widget_url` | `string` | <!--source:api-specifications-->Product widget_url listening on the connector widget_url.<!--/source--> |
| `invocation_id` | `string` | <!--source:api-specifications-->Invocation ID.<!--/source--> |
| `invocation_status` | `string` | <!--source:api-specifications-->The status of the invocation.<!--/source--> |
| `transaction_id` | `string` | <!--source:api-specifications-->Transaction ID.<!--/source--> |
| `request_data` | `object` | <!--source:api-specifications-->Request collection data.<!--/source--> |
| `people` | `object[]` | — |
| `@type` | `string` | — |
| `@id` | `string` | — |
| `has_first_name` | `object` | — |
| `has_value` | `string` | — |
| `has_last_name` | `object` | — |
| `has_value` | `string` | — |
| `contact_at` | `string[]` | — |
| `contact_information` | `object[]` | — |
| `@type` | `string` | — |
| `@id` | `string` | — |
| `has_email_address` | `object` | — |
| `has_value` | `string` | — |
| `has_phone_number` | `object` | — |
| `has_value` | `string` | — |
| `organizations` | `object[]` | — |
| `@type` | `string` | — |
| `@id` | `string` | — |
| `has_organization_name` | `object` | — |
| `has_value` | `string` | — |
| `with_address` | `string[]` | — |
| `addresses` | `object[]` | — |
| `@type` | `string` | — |
| `@id` | `string` | — |
| `has_address_line_1_text` | `object` | — |
| `has_value` | `string` | — |
| `has_address_line_2_text` | `object` | — |
| `has_value` | `string` | — |
| `has_city_name` | `object` | — |
| `has_value` | `string` | — |
| `has_state_code` | `object` | — |
| `has_value` | `string` | — |
| `has_postal_code` | `object` | — |
| `has_value` | `string` | — |
| `property` | `object[]` | — |
| `@type` | `string` | — |
| `@id` | `string` | — |
| `with_address` | `string[]` | — |
| `_links` | `object` | — |
| `health_metrics` | `string` | — |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Request data failed validation
<!--/source-->

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

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

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

`POST` `/blobs/upload`

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

#### Upload Identity Document
<!--/source-->

`uploadBlob`

<!--source:api-specifications-->
Upload Blob allows a customer to upload a document in .pdf form. Upload Blob uploads a .pdf document (blob) to Persistence product.

You can upload pdf using HTML Request Maker Try It Out. Place your api_key in the request header, set the request body to binary and browse to your document. Click Send to upload your document. To upload a document programmatically, use the programmatic upload example below. After the approval document is successfully uploaded, a blob_id value is provided. Example: 'blob_id': '01EZYHKY4EXFW4Z8RKWHDP1KHB' After you got successful response, you need to use the blob_id in collection with the following path.

Show the rest
```
$.document_sets.document_set[0].documents.document[0].foreign_objects.foreign_object[0].staircase_blob_id
```

To upload a document within code, you can to use a below example.

```
import requests

with open("document.pdf", "rb") as document:
 payload = document.read

url = ""
headers = {
 "x-api-key": ...,
 "Content-Type": "application/pdf"
}
response = requests.post(url, headers=headers, data=payload)
if response.ok:
 blob_id = response.json["blob_id"]
```

<!--/source-->

##### Request

<!--source:api-specifications-->
application/octet-stream Copy
```
Select option 'binary' in order to upload file
```

<!--/source-->

##### Response

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

<!--source:api-specifications-->
application/json Copy Blob uploaded

```
{
 "blob_id": "01EZY9J8SEFM2JKDJ1Q3YX65HS"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 403 invalid error

```
{
 "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 Internal server error

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support"
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Description |
| --- | --- | --- |
| `x-api-key` required | `string` header | <!--source:api-specifications-->The environment API key.<!--/source--> |

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

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

| Field | Type | Description |
| --- | --- | --- |
| `blob_id` | `string` | <!--source:api-specifications-->Created blob id<!--/source--> |

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

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

##### Other responses

`400``405``422`

`GET` `/identity/verification/{execution_id}`

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

#### Verify Phone Number Status
<!--/source-->

`verifyPhoneNumberStatus`

<!--source:api-specifications-->
Verify Phone Number Status Get the verification status by execution identifier.

<!--/source-->

##### Response

<!--source:api-specifications-->
200 VerifiedNumberResponse200 UnverifiedNumberResponse400403404422500
<!--/source-->

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

```
{
 "data": {
 "statuses": [
 {
 "@id": "01H1WE08FGKNX0PKNZ88AKNTBX",
 "@type": "verification_status",
 "status_code": "200",
 "verified": true,
 "status_name": "Verified"
 }
 ]
 }
}
```

<!--/source-->

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

```
{
 "data": {
 "statuses": [
 {
 "@id": "01H1Y684VCD1GJ8WSR630GDD0K",
 "@type": "verification_status",
 "status_code": "400",
 "verified": false,
 "status_name": "Failed"
 }
 ],
 "error_messages": [
 {
 "@id": "01H1Y684VCD1GJ8WSR630GDD0K",
 "@type": "error_message",
 "error_message_text": "phoneNumber invalid."
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Request data failed validation

```
{
 "code": 400,
 "message": "Bad Request"
}
```

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

```
{
 "code": 422,
 "message": "Unprocessed Entity."
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support."
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Environment API Key.<!--/source--> |
| `execution_id` required | `string` path | `01H1WE08FGKNX0PKNZ88AKNTBX` | <!--source:api-specifications-->Verification execution identifier<!--/source--> |

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

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

| Field | Type | Description |
| --- | --- | --- |
| `data` | `object` | <!--source:api-specifications-->Data<!--/source--> |
| `statuses` | `object[]` | <!--source:api-specifications-->Statuses<!--/source--> |
| `@id` | `string` | <!--source:api-specifications-->Identifier<!--/source--> |
| `@type` | `string` | <!--source:api-specifications-->Type<!--/source--> |
| `status_code` | `string` | <!--source:api-specifications-->Status code<!--/source--> |
| `verified` | `boolean` | <!--source:api-specifications-->Verified<!--/source--> |
| `status_name` | `string` | <!--source:api-specifications-->Status name<!--/source--> |
| `error_messages` | `object[]` | <!--source:api-specifications-->Statuses<!--/source--> |
| `@id` | `string` | <!--source:api-specifications-->Identifier<!--/source--> |
| `@type` | `string` | <!--source:api-specifications-->Type<!--/source--> |
| `error_message_text` | `string` | <!--source:api-specifications-->Error message text<!--/source--> |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Request data failed validation
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | <!--source:api-specifications-->Unprocessed entity error.<!--/source--> |
| `code`required | `string` | <!--source:api-specifications-->Error name.<!--/source--> |
| `message`required | `string` | <!--source:api-specifications-->Error description.<!--/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-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `422``application/json`

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

| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | <!--source:api-specifications-->Unprocessed entity error.<!--/source--> |
| `code`required | `string` | <!--source:api-specifications-->Error name.<!--/source--> |
| `message`required | `string` | <!--source:api-specifications-->Error description.<!--/source--> |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.
<!--/source-->

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

`GET` `/products/identity/invocations/{invocation_id}`

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

#### Retrieve Identity Invocation Status
<!--/source-->

`RetrieveProductFlowInvocationStatus`

<!--source:api-specifications-->
Retrieve Invocation Status
<!--/source-->

<!--source:api-specifications-->
Retrieves the status of running Product flow invocation.

<!--/source-->

##### Response

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

<!--source:api-specifications-->
application/json Copy Successfully returned status of the Product flow Invocation.

```
{
 "request_collection_id": "01GGC93ZHVCTNFDT2Q852CVF9P",
 "response_collection_id": "01GGC93ZM4ZR9SWPH7EQV9HWPX",
 "service_invocation": {
 "Persistence": {
 "run_flow_invocation": {
 "elapsed_time": "0.29608583450317383"
 },
 "process_translation_input": {
 "elapsed_time": "0.07210111618041992"
 },
 "process_translation_output": {
 "elapsed_time": "0.07207798957824707"
 },
 "translate_input": {
 "elapsed_time": "0.1422419548034668"
 },
 "total_elapsed_time": "0.16972756385803223",
 "process_connector_flow": {
 "elapsed_time": "0.16049575805664062"
 },
 "process_invocation_result": {
 "elapsed_time": "0.09764957427978516"
 }
 },
 "Connector": {
 "finished_on": "2022-10-27T04:32:24.452940-04:00",
 "elapsed_time": "8.227691",
 "connector_flow_name": "dytrix-add-company",
 "started_on": "2022-10-27T04:32:16.225249-04:00",
 "status": "COMPLETED",
 "invocation_id": "288a9e3e-31ba-4e57-87a6-d4436c0f73d8"
 },
 "Language": {
 "output": {
 "started_on": "2022-10-27T04:32:27.567001-04:00",
 "invocation_id": "01GGC94EFSV79TAHPZSCBZVPF4",
 "finished_on": "2022-10-27T04:32:28.753980-04:00",
 "elapsed_time": "1.186979",
 "from_language": "identity-dytrix-add-company-output",
 "to_language": "staircase-graph",
 "status": "TRANSLATED"
 },
 "input": {
 "started_on": "2022-10-27T04:32:13.019510-04:00",
 "invocation_id": "01GGC9405XSMEAQ9Q2G1VGPC3T",
 "finished_on": "2022-10-27T04:32:15.295687-04:00",
 "elapsed_time": "2.276177",
 "from_language": "staircase-graph",
 "to_language": "identity-dytrix-add-company-input",
 "status": "TRANSLATED"
 }
 }
 },
 "widget_url": "",
 "metadata": {},
 "options": {},
 "raw_collection": "01GGC94GGFHSZDRNMPS2CQBXXV",
 "total_integrated_elapsed_time": 11.860574563858034,
 "invocation_id": "65d45988-5678-4957-821c-ee3bbd2c0218",
 "invocation_status": "COMPLETED",
 "transaction_id": "01GGC93Z8ZWCEP40VFD5J1NF6M",
 "product_flow_name": "add-company",
 "connector_job_id": "288a9e3e-31ba-4e57-87a6-d4436c0f73d8",
 "total_elapsed_time": 23.308631,
 "product_overhead": 11.448056436141965,
 "request_collection": {
 "collection_id": "01GGC93ZHVCTNFDT2Q852CVF9P",
 "transaction_id": "01GGC93Z8ZWCEP40VFD5J1NF6M",
 "data": {
 "people": [
 {
 "@type": "appraiser",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA01",
 "has_first_name": {
 "has_value": "Joe"
 },
 "has_last_name": {
 "has_value": "Doe"
 },
 "contact_at": [
 "01FD6ZNGJADZ0RB1H96FSEAA02"
 ]
 },
 {
 "@type": "contact",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA31",
 "has_first_name": {
 "has_value": "Jane"
 },
 "has_last_name": {
 "has_value": "Smith"
 },
 "contact_at": [
 "01FD6ZNGJADZ0RB1H96FSEAA32"
 ]
 },
 {
 "@type": "borrower",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA20",
 "has_full_name": {
 "has_value": "John Smith"
 }
 }
 ],
 "contact_information": [
 {
 "@type": "contact_information",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA02",
 "has_email_address": {
 "has_value": "appraiser@appraiser.com"
 },
 "has_phone_number": {
 "has_value": "+14086002581"
 }
 },
 {
 "@type": "contact_information",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA32",
 "has_email_address": {
 "has_value": "contact@contact.com"
 },
 "has_phone_number": {
 "has_value": "+14086002582"
 }
 }
 ],
 "organizations": [
 {
 "@type": "agent_branch",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA03",
 "has_organization_name": {
 "has_value": "ACME Inc."
 },
 "with_address": [
 "01FD6ZNGJADZ0RB1H96FSEAA33"
 ]
 }
 ],
 "addresses": [
 {
 "@type": "address",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA33",
 "has_address_line_1_text": {
 "has_value": "57 Berry Lane"
 },
 "has_address_line_2_text": {
 "has_value": "Bldg 12, Apt # 22"
 },
 "has_city_name": {
 "has_value": "New York"
 },
 "has_state_code": {
 "has_value": "NY"
 },
 "has_postal_code": {
 "has_value": "10014"
 }
 },
 {
 "@type": "address",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA06",
 "has_full_address_text": {
 "has_value": "57 Berry Lane, Bldg 12, Apt # 22 New York, NY, 10014"
 }
 }
 ],
 "property": [
 {
 "@type": "property",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA05",
 "with_address": [
 "01FD6ZNGJADZ0RB1H96FSEAA06"
 ]
 }
 ],
 "loans": [
 {
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA07",
 "@type": "loan",
 "has_loan_identifier_value": {
 "has_value": "123456"
 },
 "has_loan_purpose_type": {
 "has_value": "1"
 },
 "has_loan_amount": {
 "has_value": "50000.55"
 },
 "has_loan_estimated_closing_date": {
 "has_value": "05/12/2020"
 }
 }
 ],
 "comment": [
 {
 "@type": "comment",
 "@id": "01FD6ZNGJADZ0RB1H96FSEAA08",
 "has_comment": {
 "has_value": "This is comment."
 }
 }
 ]
 },
 "metadata": {
 "validation": false,
 "linked_collections": [
 {
 "collection_id": "01GGC93ZM4ZR9SWPH7EQV9HWPX",
 "label": "Response Collection"
 }
 ],
 "created_at": "2022-10-27T04:32:11.835614-04:00",
 "last_updated_at": "2022-10-27T04:32:11.981988-04:00"
 }
 },
 "response_collection": {
 "metadata": {
 "linked_collections": [
 {
 "collection_id": "01GGC94GGFHSZDRNMPS2CQBXXV",
 "label": "Raw Response Collection"
 },
 {
 "collection_id": "01GGC93ZHVCTNFDT2Q852CVF9P",
 "label": "Request Collection"
 }
 ],
 "validation": false,
 "version": 2,
 "created_at": "2022-10-27T04:32:11.909043-04:00",
 "invocation_status": "COMPLETED",
 "last_updated_at": "2022-10-27T04:32:34.874297-04:00",
 "partner_language": "identity-dytrix-add-company-output",
 "partner_name": "dytrix",
 "product_name": "identity",
 "service_invocation": {
 "Persistence": {
 "run_flow_invocation": {
 "elapsed_time": "0.29608583450317383"
 },
 "translate_input": {
 "elapsed_time": "0.1422419548034668"
 },
 "process_translation_input": {
 "elapsed_time": "0.07210111618041992"
 },
 "process_translation_output": {
 "elapsed_time": "0.07207798957824707"
 },
 "total_elapsed_time": "0.07207798957824707",
 "process_connector_flow": {
 "elapsed_time": "0.16049575805664062"
 }
 },
 "operation_name": "language_output",
 "Connector": {
 "finished_on": "2022-10-27T04:32:24.452940-04:00",
 "elapsed_time": "8.227691",
 "connector_flow_name": "dytrix-add-company",
 "started_on": "2022-10-27T04:32:16.225249-04:00",
 "status": "COMPLETED",
 "invocation_id": "288a9e3e-31ba-4e57-87a6-d4436c0f73d8"
 },
 "Language": {
 "output": {
 "started_on": "2022-10-27T04:32:27.567001-04:00",
 "invocation_id": "01GGC94EFSV79TAHPZSCBZVPF4",
 "finished_on": "2022-10-27T04:32:28.753980-04:00",
 "elapsed_time": "1.186979",
 "from_language": "identity-dytrix-add-company-output",
 "to_language": "staircase-graph",
 "status": "TRANSLATED"
 },
 "input": {
 "started_on": "2022-10-27T04:32:13.019510-04:00",
 "invocation_id": "01GGC9405XSMEAQ9Q2G1VGPC3T",
 "finished_on": "2022-10-27T04:32:15.295687-04:00",
 "elapsed_time": "2.276177",
 "from_language": "staircase-graph",
 "to_language": "identity-dytrix-add-company-input",
 "status": "TRANSLATED"
 }
 }
 },
 "staircase_language_version": 2
 },
 "data": {
 "comment": [
 {
 "@type": "comment",
 "comment": [
 {
 "has_comment": {}
 }
 ],
 "@id": "01GGC94FVWTS8A4DDAEH9RKAX1"
 }
 ],
 "customer_request": [
 {
 "@type": "customer_request",
 "customer_request": [
 {
 "has_customer_request_identifier": {
 "has_value": 27929
 }
 }
 ],
 "@id": "01GGC94FVW0HJ44VSDJ7GSPQXT"
 }
 ]
 },
 "transaction_id": "01GGC93Z8ZWCEP40VFD5J1NF6M",
 "collection_id": "01GGC93ZM4ZR9SWPH7EQV9HWPX"
 },
 "flows_responses": {},
 "_links": {
 "finance_metrics": "https://russell-dev.staircaseapi.com/finance/metrics/query/",
 "health_metrics": "https://russell-dev.staircaseapi.com/code-health-checker/metric/01GGC93Z8ZWCEP40VFD5J1NF6M?product_name=identity"
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Request data failed validation

```
{
 "message": "{'data': ['Missing data for required field.']}"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 403 invalid error

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

<!--/source-->

<!--source:api-specifications-->
text/html Copy Resource not found

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400 Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support"
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Environment API Key.<!--/source--> |
| `invocation_id` required | `string (ulid)` path | `d7ccedb8-8889-4657-add4-bc1s4xs97637` | <!--source:api-specifications-->Product flow invocation identifier<!--/source--> |

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

<!--source:api-specifications-->
19 fields
<!--/source-->
<!--source:api-specifications-->
Successfully returned status of the Product flow Invocation.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `request_collection_id` | `string` | — |
| `response_collection_id` | `string` | — |
| `service_invocation` | `object` | — |
| `Persistence` | `object` | — |
| `run_flow_invocation` | `object` | — |
| `elapsed_time` | `string` | — |
| `process_translation_input` | `object` | — |
| `elapsed_time` | `string` | — |
| `process_translation_output` | `object` | — |
| `elapsed_time` | `string` | — |
| `translate_input` | `object` | — |
| `elapsed_time` | `string` | — |
| `total_elapsed_time` | `string` | — |
| `process_connector_flow` | `object` | — |
| `elapsed_time` | `string` | — |
| `process_invocation_result` | `object` | — |
| `elapsed_time` | `string` | — |
| `Connector` | `object` | — |
| `finished_on` | `string` | — |
| `elapsed_time` | `string` | — |
| `connector_flow_name` | `string` | — |
| `started_on` | `string` | — |
| `status` | `string` | — |
| `invocation_id` | `string` | — |
| `Language` | `object` | — |
| `output` | `object` | — |
| `started_on` | `string` | — |
| `invocation_id` | `string` | — |
| `finished_on` | `string` | — |
| `elapsed_time` | `string` | — |
| `from_language` | `string` | — |
| `to_language` | `string` | — |
| `status` | `string` | — |
| `input` | `object` | — |
| `started_on` | `string` | — |
| `invocation_id` | `string` | — |
| `finished_on` | `string` | — |
| `elapsed_time` | `string` | — |
| `from_language` | `string` | — |
| `to_language` | `string` | — |
| `status` | `string` | — |
| `widget_url` | `string` | — |
| `metadata` | `object` | — |
| `options` | `object` | — |
| `raw_collection` | `string` | — |
| `total_integrated_elapsed_time` | `number` | — |
| `invocation_id` | `string` | — |
| `invocation_status` | `string` | — |
| `transaction_id` | `string` | — |
| `product_flow_name` | `string` | — |
| `connector_job_id` | `string` | — |
| `total_elapsed_time` | `number` | — |
| `product_overhead` | `number` | — |
| `request_collection` | `object` | — |
| `collection_id` | `string` | — |
| `transaction_id` | `string` | — |
| `data` | `object` | — |
| `people` | `object[]` | — |
| `@type` | `string` | — |
| `@id` | `string` | — |
| `has_first_name` | `object` | — |
| `has_last_name` | `object` | — |
| `contact_at` | `string[]` | — |
| `has_full_name` | `object` | — |
| `contact_information` | `object[]` | — |
| `@type` | `string` | — |
| `@id` | `string` | — |
| `has_email_address` | `object` | — |
| `has_phone_number` | `object` | — |
| `organizations` | `object[]` | — |
| `@type` | `string` | — |
| `@id` | `string` | — |
| `has_organization_name` | `object` | — |
| `with_address` | `string[]` | — |
| `addresses` | `object[]` | — |
| `@type` | `string` | — |
| `@id` | `string` | — |
| `has_address_line_1_text` | `object` | — |
| `has_address_line_2_text` | `object` | — |
| `has_city_name` | `object` | — |
| `has_state_code` | `object` | — |
| `has_postal_code` | `object` | — |
| `has_full_address_text` | `object` | — |
| `property` | `object[]` | — |
| `@type` | `string` | — |
| `@id` | `string` | — |
| `with_address` | `string[]` | — |
| `loans` | `object[]` | — |
| `@id` | `string` | — |
| `@type` | `string` | — |
| `has_loan_identifier_value` | `object` | — |
| `has_loan_purpose_type` | `object` | — |
| `has_loan_amount` | `object` | — |
| `has_loan_estimated_closing_date` | `object` | — |
| `comment` | `object[]` | — |
| `@type` | `string` | — |
| `@id` | `string` | — |
| `has_comment` | `object` | — |
| `metadata` | `object` | — |
| `validation` | `boolean` | — |
| `linked_collections` | `object[]` | — |
| `collection_id` | `string` | — |
| `label` | `string` | — |
| `created_at` | `string` | — |
| `last_updated_at` | `string` | — |
| `response_collection` | `object` | — |
| `metadata` | `object` | — |
| `linked_collections` | `object[]` | — |
| `collection_id` | `string` | — |
| `label` | `string` | — |
| `validation` | `boolean` | — |
| `version` | `integer` | — |
| `created_at` | `string` | — |
| `invocation_status` | `string` | — |
| `last_updated_at` | `string` | — |
| `partner_language` | `string` | — |
| `partner_name` | `string` | — |
| `product_name` | `string` | — |
| `service_invocation` | `object` | — |
| `Persistence` | `object` | — |
| `operation_name` | `string` | — |
| `Connector` | `object` | — |
| `Language` | `object` | — |
| `staircase_language_version` | `integer` | — |
| `data` | `object` | — |
| `comment` | `object[]` | — |
| `@type` | `string` | — |
| `comment` | `object[]` | — |
| `@id` | `string` | — |
| `customer_request` | `object[]` | — |
| `@type` | `string` | — |
| `customer_request` | `object[]` | — |
| `@id` | `string` | — |
| `transaction_id` | `string` | — |
| `collection_id` | `string` | — |
| `flows_responses` | `object` | — |
| `_links` | `object` | — |
| `finance_metrics` | `string` | — |
| `health_metrics` | `string` | — |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Request data failed validation
<!--/source-->

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

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

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

`POST` `/identity/trust_score`

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

#### Retrieve Trust Score
<!--/source-->

`retrieveTrustScore`

<!--source:api-specifications-->
This endpoint retrieves trust score based on the phone number provided. Before executing this, user should set the credentials through the Set Prove Credentials API and enable static IP feature in network settings.

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "partner_name": "Prove",
 "request_data": {
 "people": [
 {
 "phone_number": "2001001686"
 }
 ]
 }
}
```

<!--/source-->

##### Response

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

<!--source:api-specifications-->
application/json Copy Invoked Retrieve Trust Score successfully

```
{
 "id": "01H1WE08FGKNX0PKNZ88AKNTBX"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Request data failed validation

```
{
 "code": 400,
 "message": "Bad Request"
}
```

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

```
{
 "code": 422,
 "message": "Unprocessed Entity."
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support."
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Environment API Key.<!--/source--> |
| `content-type` required | `string` header | `application/json` | <!--source:api-specifications-->Content Type.<!--/source--> |

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

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

| Field | Type | Description |
| --- | --- | --- |
| `partner_name`required | `string` | <!--source:api-specifications-->Partner name<!--/source--> |
| `people` | `object[]` | <!--source:api-specifications-->People for verification<!--/source--> |
| `phone_number` | `string` | <!--source:api-specifications-->Phone number<!--/source--> |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Invoked Retrieve Trust Score successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `id` | `string` | <!--source:api-specifications-->Execution identifier<!--/source--> |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Request data failed validation
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | <!--source:api-specifications-->Unprocessed entity error.<!--/source--> |
| `code`required | `string` | <!--source:api-specifications-->Error name.<!--/source--> |
| `message`required | `string` | <!--source:api-specifications-->Error description.<!--/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-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `422``application/json`

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

| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | <!--source:api-specifications-->Unprocessed entity error.<!--/source--> |
| `code`required | `string` | <!--source:api-specifications-->Error name.<!--/source--> |
| `message`required | `string` | <!--source:api-specifications-->Error description.<!--/source--> |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.
<!--/source-->

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

`GET` `/products/identity/request-schema`

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

#### Retrieve Request Schema
<!--/source-->

`retrieveRequestSchema`

<!--source:api-specifications-->
Retrieve Request Schema retrieves a JSON schema for the request to the product waterfall. It also has the option of returning an example for the request object expected through the return_example attribute.

<!--/source-->

##### Response

<!--source:api-specifications-->
200400 InvalidReturnExamplesValue400 text/html403404 GetProduct404 text/html500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Successfully returned the list of elements needed for product waterfall.

```
{
 "data": {
 "deal_sets": {
 "deal_set": [
 {
 "deals": {
 "deal": [
 {
 "parties": {
 "party": [
 {
 "customer_transaction_id": "6f039329-3fd6-44c1-a460-9af546e798de",
 "individual": {
 "contact_points": {
 "contact_point": [
 {
 "contact_point_telephone": {
 "value": "+1234567890"
 },
 "email": "test@test.com"
 }
 ]
 },
 "name": {
 "first": "John",
 "last": "Jackson"
 }
 },
 "roles": {
 "role": [
 {
 "borrower": {
 "birth_date": "1985-01-23",
 "employers": {
 "employer": [
 {
 "legal_entity": {
 "full_name": "Amazon"
 }
 }
 ]
 },
 "residences": {
 "residence": [
 {
 "address": {
 "additional_line_text": "None",
 "city": "NEW YORK",
 "country": "US",
 "line_text": "33 IRVING PLACE",
 "postal_code": "10003",
 "state": "NY"
 }
 }
 ]
 }
 }
 }
 ]
 },
 "taxpayer_identifiers": {
 "taxpayer_identifier": [
 {
 "value": "999-00-0000"
 }
 ]
 }
 }
 ]
 }
 }
 ]
 }
 }
 ]
 }
 },
 "metadata": {}
}
```

<!--/source-->

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

```
{
 "message": "Please provide one of valid return examples values: true, false"
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Error

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400 Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 403 invalid error

```
{
 "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 Resource not found

```
{
 "description": "Error Message.",
 "type": "string"
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Resource not found

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400 Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support"
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Description |
| --- | --- | --- |
| `x-api-key` required | `string` header | <!--source:api-specifications-->The environment API key.<!--/source--> |
| `return_examples` | `boolean` query | <!--source:api-specifications-->If included and set to `true`, returns one or more pre-filled examples that conform to the schema. Default to `false`<!--/source--> |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Successfully returned the list of elements needed for product waterfall.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `schema` | `object` | <!--source:api-specifications-->Element key / value<!--/source--> |

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

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

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

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

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

`POST` `/transactions`

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

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

`createTransaction`

<!--source:api-specifications-->
Create Transaction creates a transaction in Staircase. Transactions in Staircase are containers for all the data related to an instance of a transaction type. They enable you to correlate the output of various products to a single transaction type, where the transaction type depends on your line of business.

Transactions are identified by a unique key called `transaction_id`. As you use different Staircase products to gather the data needed for a specific instance of your transaction type, and receive different sets of output from each product, use the same transaction_id to correlate all the outputs to the same transaction. A `transaction_id`, when used properly, gives you a holistic view of the data related to the transaction you’ve assembled.

To access all collections associated with a given transaction_id, try out /transactions/{transaction_id}/collections

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "label": "first_transaction",
 "callback_url": "https://webhook.site/0c1c4e00-79d9-490b-a0f3-bab8b12a61d5"
}
```

<!--/source-->

##### Response

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

<!--source:api-specifications-->
application/json Copy Transaction created successfully

```
{
 "transaction_id": "01F0KHK7DN3H5JZ4QJKMYAM6GB",
 "created_at": "03/04/2021, 1:04:05 PM EST"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 403 invalid error

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support"
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Environment API Key.<!--/source--> |

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

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

| Field | Type | Description |
| --- | --- | --- |
| `callback_url` | `string (url)` | <!--source:api-specifications-->URL for receiving events about changes inside transaction<!--/source--> |
| `label` | `string` | <!--source:api-specifications-->Transaction label<!--/source--> |

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Transaction created successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `transaction_id` | `string (ulid)` | <!--source:api-specifications-->Staircase Transaction Identifier<!--/source-->Example `01F0KHK7DN3H5JZ4QJKMYAM6GB` |
| `created_at` | `string` | <!--source:api-specifications-->Staircase time string.<!--/source-->Example `03/03/2021, 8:24:04 AM EST` |

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

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

##### Other responses

`400`

`POST` `/build-payload`

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

#### Build JSON Payload
<!--/source-->

`retrieveExampleJSON`

<!--source:api-specifications-->
Build JSON Payload retrieves a JSON schema for either:

- a request for product invocation, or
- a response containing response details. To retrieve the employment verification request schema:

1. Invoke Retrieve Request Elements to get an array of product request elements.
1. Place the output from Retrieve Request Elements into the Build JSON Payload request body.
1. Place your api_key into the Build JSON Payload header.
1. Send the request to Build JSON Payload. You will receive a JSON schema in response, with null values that must be replaced with your own. To retrieve the product response schema:
1. Show the rest>Invoke Retrieve Response Elements to get the product response elements.
1. Place the output from Retrieve Response Elements into the Build JSON Payload request body.
1. Place your api_key into the Build JSON Payload header.
1. Send the request to Build JSON Payload. You will receive a JSON schema in response, with null values that will be replaced by the partner upon return of employment verification details.

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "$.deal_sets.deal_set[0].deals.deal[0].loans.loan[0].loan_identifiers.loan_identifier[0].identifier": 12345,
 "$.deal_sets.deal_set[0].deals.deal[0].parties.party[0].individual.name.first": "John",
 "$.deal_sets.deal_set[0].deals.deal[0].parties.party[0].individual.name.last": "Doe",
 "$.deal_sets.deal_set[0].deals.deal[0].parties.party[0].taxpayer_identifiers.taxpayer_identifier[0].value": 67890
}
```

<!--/source-->

##### Response

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

<!--source:api-specifications-->
application/json Copy Product Invocation Flow Payload.

```
{
 "deal_sets": {
 "deal_set": [
 {
 "deals": {
 "deal": [
 {
 "parties": {
 "party": [
 {
 "individual": {
 "name": {
 "first": "Thomas",
 "last": "Alex"
 }
 },
 "roles": {
 "role": [
 {
 "borrower": {
 "residences": {
 "residence": [
 {
 "address": {
 "city": "example city",
 "line_text": "street 101",
 "postal_code": "1234",
 "state": "state",
 "street_name": "street 23"
 }
 }
 ]
 }
 }
 }
 ]
 },
 "taxpayer_identifiers": {
 "taxpayer_identifier": [
 {
 "value": "12345"
 }
 ]
 }
 }
 ]
 }
 }
 ]
 }
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Request data failed validation

```
{
 "message": "{'data': ['Missing data for required field.']}"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 403 invalid error

```
{
 "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 Internal server error

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support"
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Description |
| --- | --- | --- |
| `x-api-key` required | `string` header | <!--source:api-specifications-->The environment API key.<!--/source--> |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Request data failed validation
<!--/source-->

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

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

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

##### Other responses

`200`

`GET` `/identity/trust_score/{execution_id}`

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

#### Retrieve Trust Score Status
<!--/source-->

`retrieveTrustScoreStatus`

<!--source:api-specifications-->
Get the trust score retrieval status by execution identifier.

<!--/source-->

##### Response

<!--source:api-specifications-->
200 Trust Score found200 Phone number not found400403404422500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Retrieve Trust Score Status

```
{
 "data": {
 "people": [
 {
 "@id": "01H1WE08FGKNX0PKNZ88AKNTBX",
 "@type": "person",
 "phone_number": null,
 "has_identity": "01H1Y684VCD1GJ8WSR630GDD0K"
 }
 ],
 "identities": [
 {
 "@id": "01H1Y684VCD1GJ8WSR630GDD0K",
 "@type": "identity",
 "identity_provider": "Prove",
 "identity_trust_score": 1000
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Retrieve Trust Score Status

```
{
 "data": {
 "error_messages": [
 {
 "@id": "01H1Y684VCD1GJ8WSR630GDD0K",
 "@type": "error_message",
 "error_message_text": "Subscriber not found."
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Request data failed validation

```
{
 "code": 400,
 "message": "Bad Request"
}
```

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

```
{
 "code": 422,
 "message": "Unprocessed Entity."
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support."
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Environment API Key.<!--/source--> |
| `execution_id` required | `string` path | `01H1WE08FGKNX0PKNZ88AKNTBX` | <!--source:api-specifications-->Verification execution identifier<!--/source--> |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Request data failed validation
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | <!--source:api-specifications-->Unprocessed entity error.<!--/source--> |
| `code`required | `string` | <!--source:api-specifications-->Error name.<!--/source--> |
| `message`required | `string` | <!--source:api-specifications-->Error description.<!--/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-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `422``application/json`

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

| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | <!--source:api-specifications-->Unprocessed entity error.<!--/source--> |
| `code`required | `string` | <!--source:api-specifications-->Error name.<!--/source--> |
| `message`required | `string` | <!--source:api-specifications-->Error description.<!--/source--> |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.
<!--/source-->

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

##### Other responses

`200`

`POST` `/identity/identity`

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

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

`retrieveIdentity`

<!--source:api-specifications-->
This endpoint retrieves identity information based on the phone number and birthdate provided. Before executing this, user should set the credentials through the Set Prove Credentials API and enable static IP feature in network settings.

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "partner_name": "Prove",
 "request_data": {
 "people": [
 {
 "phone_number": "2001001686",
 "birth_date": "1980-01-01"
 }
 ]
 }
}
```

<!--/source-->

##### Response

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

<!--source:api-specifications-->
application/json Copy Invoked Retrieve Identity successfully

```
{
 "id": "01H1WE08FGKNX0PKNZ88AKNTBX"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Request data failed validation

```
{
 "code": 400,
 "message": "Bad Request"
}
```

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

```
{
 "code": 422,
 "message": "Unprocessed Entity."
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support."
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Environment API Key.<!--/source--> |
| `content-type` required | `string` header | `application/json` | <!--source:api-specifications-->Content Type.<!--/source--> |

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

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

| Field | Type | Description |
| --- | --- | --- |
| `partner_name`required | `string` | <!--source:api-specifications-->Partner name<!--/source--> |
| `people` | `object[]` | <!--source:api-specifications-->People for verification<!--/source--> |
| `phone_number` | `string` | <!--source:api-specifications-->Phone number<!--/source--> |
| `birth_date` | `string` | <!--source:api-specifications-->Birthdate<!--/source--> |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Invoked Retrieve Identity successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `id` | `string` | <!--source:api-specifications-->Execution identifier<!--/source--> |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Request data failed validation
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | <!--source:api-specifications-->Unprocessed entity error.<!--/source--> |
| `code`required | `string` | <!--source:api-specifications-->Error name.<!--/source--> |
| `message`required | `string` | <!--source:api-specifications-->Error description.<!--/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-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `422``application/json`

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

| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | <!--source:api-specifications-->Unprocessed entity error.<!--/source--> |
| `code`required | `string` | <!--source:api-specifications-->Error name.<!--/source--> |
| `message`required | `string` | <!--source:api-specifications-->Error description.<!--/source--> |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.
<!--/source-->

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

`POST` `/transactions/{transaction_id}/collections`

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

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

`createCollection`

<!--source:api-specifications-->
Create Collection creates a collection of data points required for product invocation. A collection contains a digital representation of the input or output data for the product and is identified by `collection_id`.

The Example below contains a sample collection that you can use to make the product invocation in /get-collection

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "data": {
 "deal_sets": {
 "deal_set": [
 {
 "deals": {
 "deal": [
 {
 "parties": {
 "party": [
 {
 "customer_transaction_id": "6f039329-3fd6-44c1-a460-9af546e798de",
 "individual": {
 "contact_points": {
 "contact_point": [
 {
 "contact_point_telephone": {
 "value": "+1234567890"
 },
 "email": "test@test.com"
 }
 ]
 },
 "name": {
 "first": "John",
 "last": "Jackson"
 }
 },
 "roles": {
 "role": [
 {
 "borrower": {
 "birth_date": "1985-01-23",
 "employers": {
 "employer": [
 {
 "legal_entity": {
 "full_name": "Amazon"
 }
 }
 ]
 },
 "residences": {
 "residence": [
 {
 "address": {
 "additional_line_text": "None",
 "city": "NEW YORK",
 "country": "US",
 "line_text": "33 IRVING PLACE",
 "postal_code": "10003",
 "state": "NY"
 }
 }
 ]
 }
 }
 }
 ]
 },
 "taxpayer_identifiers": {
 "taxpayer_identifier": [
 {
 "value": "999-00-0000"
 }
 ]
 }
 }
 ]
 }
 }
 ]
 }
 }
 ]
 }
 },
 "metadata": {}
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
201400 CreateCollectionError400 text/html403404 CreateCollectionError404 text/html500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Collection created successfully

```
{
 "data": {
 "deal_sets": {
 "deal_set": [
 {
 "deals": {
 "deal": [
 {
 "parties": {
 "party": [
 {
 "customer_transaction_id": "6f039329-3fd6-44c1-a460-9af546e798de",
 "individual": {
 "contact_points": {
 "contact_point": [
 {
 "contact_point_telephone": {
 "value": "+1234567890"
 },
 "email": "test@test.com"
 }
 ]
 },
 "name": {
 "first": "John",
 "last": "Jackson"
 }
 },
 "roles": {
 "role": [
 {
 "borrower": {
 "birth_date": "1985-01-23",
 "employers": {
 "employer": [
 {
 "legal_entity": {
 "full_name": "Amazon"
 }
 }
 ]
 },
 "residences": {
 "residence": [
 {
 "address": {
 "additional_line_text": "None",
 "city": "NEW YORK",
 "country": "US",
 "line_text": "33 IRVING PLACE",
 "postal_code": "10003",
 "state": "NY"
 }
 }
 ]
 }
 }
 }
 ]
 },
 "taxpayer_identifiers": {
 "taxpayer_identifier": [
 {
 "value": "999-00-0000"
 }
 ]
 }
 }
 ]
 }
 }
 ]
 }
 }
 ]
 }
 },
 "metadata": {}
}
```

<!--/source-->

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

```
{
 "message": "Unable to create collection. Please check the collection data"
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Error

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400 Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 403 invalid error

```
{
 "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 Resource not found

```
{
 "message": "Unable to create collection. Please check the transaction ID."
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Resource not found

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400 Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support"
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | — | <!--source:api-specifications-->The environment API key.<!--/source--> |
| `transaction_id` required | `string (ulid)` path | `01F0KHK7DN3H5JZ4QJKMYAM6GB` | <!--source:api-specifications-->Staircase Transaction Identifier<!--/source--> |

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

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

| Field | Type | Description |
| --- | --- | --- |
| `data` | `object` | — |
| `deal_sets`required | `object` | — |
| `deal_set`required | `object[]` | — |
| `deals`required | `object` | — |
| `metadata` | `—` | — |

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

<!--source:api-specifications-->
4 fields
<!--/source-->
<!--source:api-specifications-->
Collection created successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `collection_id` | `string (ulid)` | <!--source:api-specifications-->Collection id<!--/source-->Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `data` | `array` | — |
| `metadata` | `object` | <!--source:api-specifications-->Metadata about collection, f.e version of used Staircase schema<!--/source--> |
| `transaction_id` | `string (ulid)` | <!--source:api-specifications-->Transaction id<!--/source-->Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |

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

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

| Field | Type | Description |
| --- | --- | --- |
| `message` | `one of` | <!--source:api-specifications-->Either message object with more properties.<!--/source--> |

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

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

`PUT` `/blobs/{blob_id}/presigned-urls/{action}`

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

#### Create Report Download URL
<!--/source-->

`createPresignedUrl`

<!--source:api-specifications-->
Create Report Download URL creates a presigned URL in Staircase. It expires one hour after creation.

If partner provides a report in the documents, you can generate a download url with using staircase blob ID.

<!--/source-->

##### Response

<!--source:api-specifications-->
200 ExampleUpload200 ExampleDownload403500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Presigned URL created successfully.

```
{
 "upload": {
 "url": "https://dev-data-manager-blobs-bucket.s3.amazonaws.com/01EZY9J8SEFM2JKDJ1Q3YX65HS"
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Presigned URL created successfully.

```
{
 "download": {
 "url": "https://dev-data-manager-blobs-bucket.s3.amazonaws.com/01EZY9J8SEFM2JKDJ1Q3YX65HS"
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 403 invalid error

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support"
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Environment API Key.<!--/source--> |
| `blob_id` required | `string` path | `01EZY9J8SEFM2JKDJ1Q3YX65HS` | <!--source:api-specifications-->Blob identifier<!--/source--> |
| `action` required | `string` path | `upload` | <!--source:api-specifications-->Action, one of ['upload', 'download']<!--/source--> |

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Presigned URL created successfully.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `upload` | `object` | <!--source:api-specifications-->Action<!--/source--> |
| `url` | `string` | <!--source:api-specifications-->Presigned_url<!--/source--> |
| `download` | `object` | <!--source:api-specifications-->Action<!--/source--> |
| `url` | `string` | <!--source:api-specifications-->Presigned_url<!--/source--> |

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

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

##### Other responses

`400`

`GET` `/identity/identity/{execution_id}`

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

#### Retrieve Identity Status
<!--/source-->

`retrieveIdentityStatus`

<!--source:api-specifications-->
Get the identity retrieval status by execution identifier.

<!--/source-->

##### Response

<!--source:api-specifications-->
200 Identity found200 Identity not found400403404422500
<!--/source-->

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

```
{
 "data": {
 "people": [
 {
 "@id": "01H1WE08FGKNX0PKNZ88AKNTBX",
 "@type": "person",
 "first_name": "Tom",
 "last_name": "Odell",
 "phone_number": "2001231686",
 "ssn": "283992634",
 "birth_date": "1988-10-05",
 "has_address": [
 "01H4DT7QY42XRKM2Y3XKKJ6635"
 ]
 }
 ],
 "addresses": [
 {
 "@id": "01H4DT7QY42XRKM2Y3XKKJ6635",
 "@type": "address",
 "address_line_1": "23A Main Street",
 "city_name": "Philadelphia",
 "postal_code": "32210-2955"
 }
 ]
 }
}
```

<!--/source-->

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

```
{
 "data": {
 "error_messages": [
 {
 "@id": "01H1Y684VCD1GJ8WSR630GDD0K",
 "@type": "error_message",
 "error_message_text": "Subscriber not found."
 }
 ]
 }
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Request data failed validation

```
{
 "code": 400,
 "message": "Bad Request"
}
```

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

```
{
 "code": 422,
 "message": "Unprocessed Entity."
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support."
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Environment API Key.<!--/source--> |
| `execution_id` required | `string` path | `01H1WE08FGKNX0PKNZ88AKNTBX` | <!--source:api-specifications-->Verification execution identifier<!--/source--> |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Request data failed validation
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | <!--source:api-specifications-->Unprocessed entity error.<!--/source--> |
| `code`required | `string` | <!--source:api-specifications-->Error name.<!--/source--> |
| `message`required | `string` | <!--source:api-specifications-->Error description.<!--/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-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Invalid key for service
<!--/source-->

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

##### Response `422``application/json`

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

| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | <!--source:api-specifications-->Unprocessed entity error.<!--/source--> |
| `code`required | `string` | <!--source:api-specifications-->Error name.<!--/source--> |
| `message`required | `string` | <!--source:api-specifications-->Error description.<!--/source--> |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.
<!--/source-->

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

##### Other responses

`200`

`GET` `/transactions/{transaction_id}/collections/{collection_id}`

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

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

`retrieveCollection`

<!--source:api-specifications-->
Retrieve Collection returns the content of a given `collection_id` associated with a `transaction_id`.

<!--/source-->

##### Response

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

<!--source:api-specifications-->
application/json Copy Successfully Retrieved Collection

```
{
 "data": {
 "deal_sets": {
 "deal_set": [
 {
 "deals": {
 "deal": [
 {
 "parties": {
 "party": [
 {
 "customer_transaction_id": "6f039329-3fd6-44c1-a460-9af546e798de",
 "individual": {
 "contact_points": {
 "contact_point": [
 {
 "contact_point_telephone": {
 "value": "+1234567890"
 },
 "email": "test@test.com"
 }
 ]
 },
 "name": {
 "first": "John",
 "last": "Jackson"
 }
 },
 "roles": {
 "role": [
 {
 "borrower": {
 "birth_date": "1985-01-23",
 "employers": {
 "employer": [
 {
 "legal_entity": {
 "full_name": "Amazon"
 }
 }
 ]
 },
 "residences": {
 "residence": [
 {
 "address": {
 "additional_line_text": "None",
 "city": "NEW YORK",
 "country": "US",
 "line_text": "33 IRVING PLACE",
 "postal_code": "10003",
 "state": "NY"
 }
 }
 ]
 }
 }
 }
 ]
 },
 "taxpayer_identifiers": {
 "taxpayer_identifier": [
 {
 "value": "999-00-0000"
 }
 ]
 }
 }
 ]
 }
 }
 ]
 }
 }
 ]
 }
 },
 "metadata": {}
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 403 invalid error

```
{
 "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 Resource not found

```
{
 "message": "Unable to get collection. Please check the given ids"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Resource not found

```
{
 "message": "Unable to get collections of given transaction. Please check the transaction id"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support"
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | — | <!--source:api-specifications-->The environment API key.<!--/source--> |
| `transaction_id` required | `string (ulid)` path | `01F0KHK7DN3H5JZ4QJKMYAM6GB` | <!--source:api-specifications-->Staircase Transaction Identifier<!--/source--> |
| `collection_id` required | `string (ulid)` path | `01F0KHKADN0HRFXMCQQXPA6AFZ` | <!--source:api-specifications-->Staircase collection_id<!--/source--> |

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Successfully Retrieved Collection
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `data` | `object` | — |
| `deal_sets`required | `object` | — |
| `deal_set`required | `object[]` | — |
| `deals`required | `object` | — |
| `metadata` | `—` | — |

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

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

##### Other responses

`400`

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

### Partners
<!--/source-->

`GET` `/products/identity/partners`

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

#### Retrieve Product Partners
<!--/source-->

`getVendors`

<!--source:api-specifications-->
Retrieve Partners retrieves:

-All the Partners (vendors) configured in the Product Flows configurations.

-The Order of the partner in the Product Waterfall Settings or default order in Product Flows if Product Waterfall was not configured.

-The status of the partners as active/upcoming according to the configurations of the product flows of these partners (partner will be active if at least one flow is active).'

<!--/source-->

##### Response

<!--source:api-specifications-->
200 Example1200 Example2400403404 GetProduct404 text/html500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Successfully retrieved product partners.

```
[
 {
 "partner": "partner_name",
 "order": 1,
 "active": true,
 "status": "active"
 }
]
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Successfully retrieved product partners.

```
[
 {
 "partner": "partner_name",
 "order": 1,
 "active": false,
 "status": "inactive"
 }
]
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Validation Error

```
{
 "message": "3 is not of type 'string'. Failed validating 'type' in schema['properties']['deal_sets']['items'][0]['properties']['parties']['items'][0]['properties']['customer_transaction_ID']:"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 403 invalid error

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy Resource not found

```
{
 "type": "string",
 "description": "Error Message."
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Resource not found

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400 Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support"
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Environment API Key.<!--/source--> |
| `active` | `boolean` query | `false` | <!--source:api-specifications-->Include vendors with active product flows<!--/source--> |

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

<!--source:api-specifications-->
4 fields
<!--/source-->
<!--source:api-specifications-->
Successfully retrieved product partners.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `partner` | `string` | <!--source:api-specifications-->Partner name<!--/source--> |
| `order` | `number` | <!--source:api-specifications-->Order of the product flows associated with this partner<!--/source--> |
| `active` | `boolean` | <!--source:api-specifications-->Partner has active flows<!--/source--> |
| `status` | `string` | <!--source:api-specifications-->Status of the partner<!--/source--> |

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

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

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

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

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

`GET` `/products/identity/partners/ordering`

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

#### Retrieve Partners Ordering
<!--/source-->

`getPartnersOrdering`

<!--source:api-specifications-->
Retrieve Partners Ordering retrieves the partners'' order for the product waterfall invocation according to the configured Product Waterfall Settings. If there is no waterfall for the product configured, partners will be retrieved with the default of the order inside Product Flows.

<!--/source-->

##### Response

<!--source:api-specifications-->
200400403404 GetProduct404 text/html500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Successfully retrieved partners ordering.

```
[
 {
 "partner": "partner1",
 "order": 1
 },
 {
 "partner": "partner2",
 "order": 2
 }
]
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Validation Error

```
{
 "message": "3 is not of type 'string'. Failed validating 'type' in schema['properties']['deal_sets']['items'][0]['properties']['parties']['items'][0]['properties']['customer_transaction_ID']:"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 403 invalid error

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy Resource not found

```
{
 "type": "string",
 "description": "Error Message."
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Resource not found

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400 Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support"
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Environment API Key.<!--/source--> |

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Successfully retrieved partners ordering.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `partner` | `string` | <!--source:api-specifications-->Partner name<!--/source--> |
| `order` | `number` | <!--source:api-specifications-->Order of the product flows associated with this partner<!--/source--> |

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

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

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

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

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

`PUT` `/products/identity/partners/ordering`

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

#### Update Partners Ordering
<!--/source-->

`UpdatePartnersOrdering`

<!--source:api-specifications-->
Update Partners Order updates the order of execution of the product flows associated with the partner by updating their order in the product waterfall settings.

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "ordering": [
 {
 "partner": "partner1",
 "order": 1
 },
 {
 "partner": "partner2",
 "order": 10
 }
 ]
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
200400 application/json400 text/html403404 GetProduct404 text/html500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Successfully updated partners ordering.

```
[
 {
 "partner": "partner1",
 "order": 1
 },
 {
 "partner": "partner2",
 "order": 10
 }
]
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Failed to update the partner from one of the reasons

```
{
 "message": "Partner doesn't exist in database"
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Failed to update the partner from one of the reasons

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400 Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 403 invalid error

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy Resource not found

```
{
 "type": "string",
 "description": "Error Message."
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Resource not found

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400 Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support"
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Environment API Key.<!--/source--> |

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

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

| Field | Type | Description |
| --- | --- | --- |
| `ordering` | `object[]` | — |
| `partner` | `string` | <!--source:api-specifications-->Partner name<!--/source-->Example `wage` |
| `order` | `number` | <!--source:api-specifications-->Partner order<!--/source-->Example `1` |

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Successfully updated partners ordering.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `partner` | `string` | <!--source:api-specifications-->Partner name<!--/source-->Example `wage` |
| `order` | `number` | <!--source:api-specifications-->Partner order<!--/source-->Example `1` |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Failed to update the partner from one of the reasons
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Partner doesn't exist in database<!--/source--> |

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

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

`PATCH` `/products/identity/partners/{partner}/status`

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

#### Update Partner Status
<!--/source-->

`updatePartnerStatus`

<!--source:api-specifications-->
Update Partner Status updates the active value of a specific partner to value true or false. This shall activate or deactivate the flows configured for this partner in Product Flows.

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "active": true,
 "verification_type": "borrower",
 "byoc": true,
 "status": "active"
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
200400 application/json400 text/html403404 GetProduct404 text/html500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Successfully updated active parameter for the partner.

```
{
 "message": "Partner status updated."
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Failed to update the partner from one of the reasons.

```
{
 "message": "Partner doesn't exist in database."
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Failed to update the partner from one of the reasons.

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400 Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 403 invalid error

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy Resource not found

```
{
 "type": "string",
 "description": "Error Message."
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Resource not found

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400 Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support"
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Environment API Key.<!--/source--> |
| `partner` required | `string` path | `partner_name` | <!--source:api-specifications-->Name of the partner for which we wan't to update status.<!--/source--> |

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

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

| Field | Type | Description |
| --- | --- | --- |
| `active`required | `boolean` | Example `true` |
| `byoc` | `boolean` | <!--source:api-specifications-->Specify whether customer should add its own partner credentials or not<!--/source--> |
| `status` | `string` | <!--source:api-specifications-->Status of the vendor<!--/source--> |
| `verification_type` | `string` | <!--source:api-specifications-->Type of verification<!--/source--> |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Successfully updated active parameter for the partner.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Partner status updated.<!--/source--> |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Failed to update the partner from one of the reasons.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | <!--source:api-specifications-->Partner doesn't exist in database.<!--/source--> |

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

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

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

### Platform
<!--/source-->

`GET` `/products/identity/response-schema`

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

#### Retrieve Response Schema
<!--/source-->

`retrieveResponseSchema`

<!--source:api-specifications-->
Retrieve Schema retrieves a JSON schema for the response returned by the product. It can also return an example for the response output object through return_example attribute.

<!--/source-->

##### Response

<!--source:api-specifications-->
200400 InvalidReturnExamplesValue400 text/html403404 GetProduct404 text/html500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Successfully returned the list of elements of response of the product waterfall.

```
{
 "data": {
 "deal_sets": {
 "deal_set": [
 {
 "deals": {
 "deal": [
 {
 "parties": {
 "party": [
 {
 "customer_transaction_id": "6f039329-3fd6-44c1-a460-9af546e798de",
 "individual": {
 "contact_points": {
 "contact_point": [
 {
 "contact_point_telephone": {
 "value": "+1234567890"
 },
 "email": "test@test.com"
 }
 ]
 },
 "name": {
 "first": "John",
 "last": "Jackson"
 }
 },
 "roles": {
 "role": [
 {
 "borrower": {
 "birth_date": "1985-01-23",
 "employers": {
 "employer": [
 {
 "legal_entity": {
 "full_name": "Amazon"
 }
 }
 ]
 },
 "residences": {
 "residence": [
 {
 "address": {
 "additional_line_text": "None",
 "city": "NEW YORK",
 "country": "US",
 "line_text": "33 IRVING PLACE",
 "postal_code": "10003",
 "state": "NY"
 }
 }
 ]
 }
 }
 }
 ]
 },
 "taxpayer_identifiers": {
 "taxpayer_identifier": [
 {
 "value": "999-00-0000"
 }
 ]
 }
 }
 ]
 }
 }
 ]
 }
 }
 ]
 }
 },
 "metadata": {}
}
```

<!--/source-->

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

```
{
 "message": "Please provide one of valid return examples values: true, false"
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Error

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400 Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 403 invalid error

```
{
 "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 Resource not found

```
{
 "description": "Error Message.",
 "type": "string"
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Resource not found

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400 Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support"
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Description |
| --- | --- | --- |
| `x-api-key` required | `string` header | <!--source:api-specifications-->The environment API key.<!--/source--> |
| `return_examples` | `boolean` query | <!--source:api-specifications-->If included and set to `true`, returns one or more pre-filled examples that conform to the schema. Default to `false`<!--/source--> |

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Successfully returned the list of elements of response of the product waterfall.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `schema` | `object` | <!--source:api-specifications-->Element key / value element<!--/source--> |

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

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

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

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

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

`GET` `/products/identity/schema/{data_object}`

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

#### Retrieve Product Schemas and Examples
<!--/source-->

`retrieveSchema`

<!--source:api-specifications-->
Retrieve Product Schemas and Examples retrieves a JSON schema for the request and the response returned by the product. It can also return an example of a json object defined with schema.

<!--/source-->

##### Response

<!--source:api-specifications-->
200400 InvalidDataObject400 InvalidVersionValue400 MissingVersionParameter400 InvalidReturnExamplesValue400 text/html403404 GetProduct404 text/html500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Successfully returned the list of elements needed for Income.

```
{
 "type": "object",
 "description": "get-report",
 "properties": {
 "people": {
 "type": "array",
 "items": {
 "type": "object",
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_first_name": {
 "type": "object",
 "properties": {
 "has_value": {
 "type": "string"
 }
 },
 "additionalProperties": false
 },
 "has_last_name": {
 "type": "object",
 "properties": {
 "has_value": {
 "type": "string"
 }
 },
 "additionalProperties": false
 },
 "contact_at": {
 "type": "array",
 "items": {
 "type": "string"
 }
 },
 "has_full_name": {
 "type": "object",
 "properties": {
 "has_value": {
 "type": "string"
 }
 },
 "additionalProperties": false
 }
 },
 "additionalProperties": false
 }
 },
 "contact_information": {
 "type": "array",
 "items": {
 "type": "object",
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_email_address": {
 "type": "object",
 "properties": {
 "has_value": {
 "type": "string"
 }
 },
 "additionalProperties": false
 },
 "has_phone_number": {
 "type": "object",
 "properties": {
 "has_value": {
 "type": "string"
 }
 },
 "additionalProperties": false
 }
 },
 "additionalProperties": false
 }
 },
 "organizations": {
 "type": "array",
 "items": {
 "type": "object",
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_organization_identifier": {
 "type": "object",
 "properties": {
 "has_value": {
 "type": "string"
 }
 },
 "additionalProperties": false
 }
 },
 "additionalProperties": false
 }
 },
 "addresses": {
 "type": "array",
 "items": {
 "type": "object",
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_full_address_text": {
 "type": "object",
 "properties": {
 "has_value": {
 "type": "string"
 }
 },
 "additionalProperties": false
 },
 "has_state_code": {
 "type": "object",
 "properties": {
 "has_value": {
 "type": "string"
 }
 },
 "additionalProperties": false
 }
 },
 "additionalProperties": false
 }
 },
 "property": {
 "type": "array",
 "items": {
 "type": "object",
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "with_address": {
 "type": "array",
 "items": {
 "type": "string"
 }
 }
 },
 "additionalProperties": false
 }
 },
 "loans": {
 "type": "array",
 "items": {
 "type": "object",
 "properties": {
 "@id": {
 "type": "string"
 },
 "@type": {
 "type": "string"
 },
 "has_loan_identifier_value": {
 "type": "object",
 "properties": {
 "has_value": {
 "type": "string"
 }
 },
 "additionalProperties": false
 },
 "has_loan_purpose_type": {
 "type": "object",
 "properties": {
 "has_value": {
 "type": "string"
 }
 },
 "additionalProperties": false
 },
 "has_loan_amount": {
 "type": "object",
 "properties": {
 "has_value": {
 "type": "string"
 }
 },
 "additionalProperties": false
 },
 "has_loan_estimated_closing_date": {
 "type": "object",
 "properties": {
 "has_value": {
 "type": "string"
 }
 },
 "additionalProperties": false
 }
 },
 "additionalProperties": false
 }
 },
 "comment": {
 "type": "array",
 "items": {
 "type": "object",
 "properties": {
 "@type": {
 "type": "string"
 },
 "@id": {
 "type": "string"
 },
 "has_comment": {
 "type": "object",
 "properties": {
 "has_value": {
 "type": "string"
 }
 },
 "additionalProperties": false
 }
 },
 "additionalProperties": false
 }
 }
 },
 "additionalProperties": false
}
```

<!--/source-->

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

```
{
 "message": "Please provide one of valid data object values: request, response"
}
```

<!--/source-->

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

```
{
 "message": "Please provide one of valid version values: v0"
}
```

<!--/source-->

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

```
{
 "message": "Please make sure your query parameters contains version parameter."
}
```

<!--/source-->

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

```
{
 "message": "Please provide one of valid return examples values: true, false"
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Error

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400 Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 403 invalid error

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

<!--/source-->

<!--source:api-specifications-->
application/json Copy Resource not found

```
{
 "type": "string",
 "description": "Error Message."
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Resource not found

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400 Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support"
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Environment API Key.<!--/source--> |
| `data_object` required | `string` path | `request` | <!--source:api-specifications-->Describes the particular data object you are getting a schema for. Can be either request or response.<!--/source--> |
| `return_examples` | `boolean` query | `false` | <!--source:api-specifications-->If included and set to `true`, returns one or more pre-filled examples that conform to the schema. Default to `false`<!--/source--> |

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

<!--source:api-specifications-->
7 fields
<!--/source-->
<!--source:api-specifications-->
Successfully returned the list of elements needed for Income.
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `people` | `object[]` | — |
| `@type` | `string` | — |
| `@id` | `string` | — |
| `has_first_name` | `object` | — |
| `has_value` | `string` | — |
| `has_last_name` | `object` | — |
| `has_value` | `string` | — |
| `contact_at` | `string[]` | — |
| `has_full_name` | `object` | — |
| `has_value` | `string` | — |
| `contact_information` | `object[]` | — |
| `@type` | `string` | — |
| `@id` | `string` | — |
| `has_email_address` | `object` | — |
| `has_value` | `string` | — |
| `has_phone_number` | `object` | — |
| `has_value` | `string` | — |
| `organizations` | `object[]` | — |
| `@type` | `string` | — |
| `@id` | `string` | — |
| `has_organization_identifier` | `object` | — |
| `has_value` | `string` | — |
| `addresses` | `object[]` | — |
| `@type` | `string` | — |
| `@id` | `string` | — |
| `has_full_address_text` | `object` | — |
| `has_value` | `string` | — |
| `has_state_code` | `object` | — |
| `has_value` | `string` | — |
| `property` | `object[]` | — |
| `@type` | `string` | — |
| `@id` | `string` | — |
| `with_address` | `string[]` | — |
| `loans` | `object[]` | — |
| `@id` | `string` | — |
| `@type` | `string` | — |
| `has_loan_identifier_value` | `object` | — |
| `has_value` | `string` | — |
| `has_loan_purpose_type` | `object` | — |
| `has_value` | `string` | — |
| `has_loan_amount` | `object` | — |
| `has_value` | `string` | — |
| `has_loan_estimated_closing_date` | `object` | — |
| `has_value` | `string` | — |
| `comment` | `object[]` | — |
| `@type` | `string` | — |
| `@id` | `string` | — |
| `has_comment` | `object` | — |
| `has_value` | `string` | — |

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

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

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

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

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

`GET` `/transactions/{transaction_id}/collections`

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

#### Retrieve Transaction Collections
<!--/source-->

`RetrieveTransactionCollections`

<!--source:api-specifications-->
Retrieve Transaction Collections returns the content of a given `collection_id` associated with a specific `transaction_id`.

<!--/source-->

##### Response

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

<!--source:api-specifications-->
application/json Copy Transaction collection retrieved successfully

```
[
 {
 "data": {
 "deal_sets": {
 "deal_set": [
 {
 "deals": {
 "deal": [
 {
 "parties": {
 "party": [
 {
 "customer_transaction_id": "6f039329-3fd6-44c1-a460-9af546e798de",
 "individual": {
 "contact_points": {
 "contact_point": [
 {
 "contact_point_telephone": {
 "value": "+1234567890"
 },
 "email": "test@test.com"
 }
 ]
 },
 "name": {
 "first": "John",
 "last": "Jackson"
 }
 },
 "roles": {
 "role": [
 {
 "borrower": {
 "birth_date": "1985-01-23",
 "employers": {
 "employer": [
 {
 "legal_entity": {
 "full_name": "Amazon"
 }
 }
 ]
 },
 "residences": {
 "residence": [
 {
 "address": {
 "additional_line_text": "None",
 "city": "NEW YORK",
 "country": "US",
 "line_text": "33 IRVING PLACE",
 "postal_code": "10003",
 "state": "NY"
 }
 }
 ]
 }
 }
 }
 ]
 },
 "taxpayer_identifiers": {
 "taxpayer_identifier": [
 {
 "value": "999-00-0000"
 }
 ]
 }
 }
 ]
 }
 }
 ]
 }
 }
 ]
 }
 },
 "metadata": {}
 },
 {
 "data": {
 "deal_sets.deal_set[0].deals.deal[0].parties.party[0].individual.contact_points.contact_point[0].contact_point_telephone": {
 "matched": [
 "Ekata",
 "Socure 30",
 "Lexis Nexis Instant ID"
 ],
 "score": 1,
 "unmatched": []
 },
 "deal_sets.deal_set[0].deals.deal[0].parties.party[0].individual.contact_points.contact_point[0].email": {
 "matched": [
 "Ekata",
 "Socure 30"
 ],
 "score": 0.99,
 "unmatched": []
 },
 "deal_sets.deal_set[0].deals.deal[0].parties.party[0].individual.name": {
 "matched": [
 "Socure 30",
 "Lexis Nexis Instant ID"
 ],
 "score": 0.99,
 "unmatched": []
 },
 "deal_sets.deal_set[0].deals.deal[0].parties.party[0].roles.role[0].borrower.birth_date": {
 "matched": [
 "Socure 30",
 "Lexis Nexis Instant ID"
 ],
 "score": 0.99,
 "unmatched": []
 },
 "deal_sets.deal_set[0].deals.deal[0].parties.party[0].roles.role[0].borrower.residences.residence[0].address": {
 "matched": [
 "Ekata",
 "Socure 30",
 "Lexis Nexis Instant ID"
 ],
 "score": 1,
 "unmatched": []
 },
 "deal_sets.deal_set[0].deals.deal[0].parties.party[0].taxpayer_identifiers.taxpayer_identifier[0].value": {
 "matched": [
 "Socure 30",
 "Lexis Nexis Instant ID"
 ],
 "score": 0.99,
 "unmatched": []
 }
 },
 "metadata": {}
 }
]
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Error

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400 Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 403 invalid error

```
{
 "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 Resource not found

```
{
 "message": "Unable to get collections of given transaction. Please check the transaction id"
}
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support"
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | — | <!--source:api-specifications-->The environment API key.<!--/source--> |
| `transaction_id` required | `string (ulid)` path | `01F0KHK7DN3H5JZ4QJKMYAM6GB` | <!--source:api-specifications-->Staircase Transaction Identifier<!--/source--> |

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

<!--source:api-specifications-->
4 fields
<!--/source-->
<!--source:api-specifications-->
Transaction collection retrieved successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `collection_id` | `string (ulid)` | <!--source:api-specifications-->Collection id<!--/source-->Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |
| `data` | `array` | — |
| `metadata` | `object` | <!--source:api-specifications-->Metadata about collection, f.e version of used Staircase schema<!--/source--> |
| `transaction_id` | `string (ulid)` | <!--source:api-specifications-->Transaction id<!--/source-->Example `01EZQ32PJQGKRA6HR8D72Q9FFF` |

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

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

| Field | Type | Description |
| --- | --- | --- |
| `message` | `one of` | <!--source:api-specifications-->Either message object with more properties.<!--/source--> |

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

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

`PUT` `/transactions/{transaction_id}/collections/{collection_id}`

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

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

`updateCollection`

<!--source:api-specifications-->
Update Collection allows you to update the content of a given `collection_id` associated with a `transaction_id`.

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "data": {
 "deal_sets": {
 "deal_set": [
 {
 "deals": {
 "deal": [
 {
 "parties": {
 "party": [
 {
 "customer_transaction_id": "6f039329-3fd6-44c1-a460-9af546e798de",
 "individual": {
 "contact_points": {
 "contact_point": [
 {
 "contact_point_telephone": {
 "value": "+1234567890"
 },
 "email": "test@test.com"
 }
 ]
 },
 "name": {
 "first": "John",
 "last": "Jackson"
 }
 },
 "roles": {
 "role": [
 {
 "borrower": {
 "birth_date": "1985-01-23",
 "employers": {
 "employer": [
 {
 "legal_entity": {
 "full_name": "Amazon"
 }
 }
 ]
 },
 "residences": {
 "residence": [
 {
 "address": {
 "additional_line_text": "None",
 "city": "NEW YORK",
 "country": "US",
 "line_text": "33 IRVING PLACE",
 "postal_code": "10003",
 "state": "NY"
 }
 }
 ]
 }
 }
 }
 ]
 },
 "taxpayer_identifiers": {
 "taxpayer_identifier": [
 {
 "value": "999-00-0000"
 }
 ]
 }
 }
 ]
 }
 }
 ]
 }
 }
 ]
 }
 },
 "metadata": {}
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
200400 UpdateCollectionError400 text/html403404 UpdateCollectionError404 text/html500
<!--/source-->

<!--source:api-specifications-->
application/json Copy Collection updated successfully

```
{
 "data": {
 "deal_sets": {
 "deal_set": [
 {
 "deals": {
 "deal": [
 {
 "parties": {
 "party": [
 {
 "customer_transaction_id": "6f039329-3fd6-44c1-a460-9af546e798de",
 "individual": {
 "contact_points": {
 "contact_point": [
 {
 "contact_point_telephone": {
 "value": "+1234567890"
 },
 "email": "test@test.com"
 }
 ]
 },
 "name": {
 "first": "John",
 "last": "Jackson"
 }
 },
 "roles": {
 "role": [
 {
 "borrower": {
 "birth_date": "1985-01-23",
 "employers": {
 "employer": [
 {
 "legal_entity": {
 "full_name": "Amazon"
 }
 }
 ]
 },
 "residences": {
 "residence": [
 {
 "address": {
 "additional_line_text": "None",
 "city": "NEW YORK",
 "country": "US",
 "line_text": "33 IRVING PLACE",
 "postal_code": "10003",
 "state": "NY"
 }
 }
 ]
 }
 }
 }
 ]
 },
 "taxpayer_identifiers": {
 "taxpayer_identifier": [
 {
 "value": "999-00-0000"
 }
 ]
 }
 }
 ]
 }
 }
 ]
 }
 }
 ]
 }
 },
 "metadata": {}
}
```

<!--/source-->

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

```
{
 "description": "Error details.",
 "message": "Unable to update collection. Please check the collection data"
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Error

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400 Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy 403 invalid error

```
{
 "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 Resource not found

```
{
 "message": "Unable to update collection. Please check the given ids"
}
```

<!--/source-->

<!--source:api-specifications-->
text/html Copy Resource not found

```
<html>\r\n<head><title>400 Bad Request</title></head>\r\n<body>\r\n<center><h1>400 Bad Request</h1></center>\r\n</body>\r\n</html>\r\n
```

<!--/source-->

<!--source:api-specifications-->
application/json Copy Internal server error

```
{
 "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support"
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | — | <!--source:api-specifications-->The environment API key.<!--/source--> |
| `transaction_id` required | `string (ulid)` path | `01F0KHK7DN3H5JZ4QJKMYAM6GB` | <!--source:api-specifications-->Staircase Transaction Identifier<!--/source--> |
| `collection_id` required | `string (ulid)` path | `01F0KHKADN0HRFXMCQQXPA6AFZ` | <!--source:api-specifications-->Staircase collection_id<!--/source--> |

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

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

| Field | Type | Description |
| --- | --- | --- |
| `data` | `object` | — |
| `deal_sets`required | `object` | — |
| `deal_set`required | `object[]` | — |
| `deals`required | `object` | — |
| `metadata` | `—` | — |

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Collection updated successfully
<!--/source-->

| Field | Type | Description |
| --- | --- | --- |
| `data` | `object` | — |
| `deal_sets`required | `object` | — |
| `deal_set`required | `object[]` | — |
| `deals`required | `object` | — |
| `metadata` | `—` | — |

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

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

| Field | Type | Description |
| --- | --- | --- |
| `message` | `one of` | <!--source:api-specifications-->Either message object with more properties.<!--/source--> |

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
403 invalid error
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Resource not found
<!--/source-->

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

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

<!--source:api-specifications-->
1 fields
<!--/source-->
<!--source:api-specifications-->
Internal server error
<!--/source-->

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

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

### Operations
<!--/source-->

`POST` `/identity`

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

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

`post-identity`

<!--source:api-specifications-->
Create Identity creates views verifying the authenticity of a borrower's ID, the addresses a borrower listed on documents, and other identification tags, to ensure the borrower behind a loan application is who they say they are.

<!--/source-->

##### Request

<!--source:api-specifications-->
application/json Copy
```
{
 "transaction_id": "uhz6t54e-9d74-g17e-99ca-a36b30vdfd35",
 "collection_id": "hg62e49f-9d74-g17e-99ca-a36b30vdfd35",
 "partner_name": "PartnerName"
}
```

<!--/source-->

##### Response

<!--source:api-specifications-->
application/json Copy Identity request created successfully.

```
{
 "collection_id": "e4502ed2-8df8-4b8f-84bd-a1097e999a77",
 "message": "When ready, data will be available under the following collection_id. Use this new collection_id to get the execution status."
}
```

<!--/source-->

##### Parameters

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

| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | <!--source:api-specifications-->Authorization key<!--/source--> |

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

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

| Field | Type | Description |
| --- | --- | --- |
| `transaction_id`required | `string` | <!--source:api-specifications-->Transaction ID<!--/source--> |
| `collection_id`required | `string` | <!--source:api-specifications-->Collection ID<!--/source--> |
| `partner_name`required | `string` | — |

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

<!--source:api-specifications-->
2 fields
<!--/source-->
<!--source:api-specifications-->
Identity request created successfully.
<!--/source-->

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

## Canonical model

- `property`
- `property`

## Property data it reads

- property

## Providers

- MeridianLink
- Prove

## Errors

`400``403``404``405``422``500`

## More in Verification

- Previous product: Employment
- Next product: Income