# Host
# Host
Deploying a third-party vendor's own software to run inside a customer-managed cloud account.
Some vendors sell software rather than an API, and some data cannot leave a customer's account. Host installs the vendor's engine inside the customer's own environment and operates it there, so the integration behaves like every other one while the documents never leave.
Document-extraction engines are the main case. The vendors installed this way appear below.
## How it works
The alternative was routing documents to a vendor's cloud, which is a different data-residency position and a different contract. Installing the engine locally keeps both the integration surface and the residency boundary intact at once.
## Operations
### Hostings
`POST` `/hostings`
#### Create New
`CreateNewHosting`
Create New Hosting endpoint
##### Request
application/jsonapplication/json
application/json Copy
```
{
"ami_id": "Example AMI",
"instance_type": "Example Instance Type"
}
```
application/json Copy
```
{
"ami_id": null,
"instance_type": null
}
```
##### Response
200400403500
application/json Copy Ok.
```
{
"code": 200,
"message": {
"host_name": "test"
}
}
```
application/json Copy Bad request
```
{
"message": "Bad Request"
}
```
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"
}
```
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."
}
```
##### Response `200``application/json`
2 fields
Ok.
| Field | Type | Description |
| --- | --- | --- |
| `code` | `integer` | Status Code. |
| `message` | `object` | Payload |
##### Response `400``application/json`
2 fields
Bad request
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `500``application/json`
1 fields
The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
`GET` `/hostings/{hosting_name}`
#### Get by name
`GetHosting`
Get Hosting endpoint
##### Response
200400403404500
application/json Copy Ok.
```
{
"code": 200,
"message": {
"host": "example"
}
}
```
application/json Copy Bad request
```
{
"message": "Bad Request"
}
```
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"
}
```
application/json Copy Error
```
{
"message": "Unable to find a hosting with given parameters."
}
```
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."
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `hosting_name` required | `string` path | `Test` | Hosting Name |
##### Response `200``application/json`
2 fields
Ok.
| Field | Type | Description |
| --- | --- | --- |
| `code` | `integer` | Status Code. |
| `message` | `object` | Payload |
##### Response `400``application/json`
2 fields
Bad request
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `404``application/json`
1 fields
Error
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | — |
##### Response `500``application/json`
1 fields
The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
`DELETE` `/hostings/{hosting_name}`
#### Remove by name
`RemoveHosting`
Remove Hosting endpoint
##### Response
200400403404500
application/json Copy Ok.
```
{
"code": 200,
"message": {
"info": "example"
}
}
```
application/json Copy Bad request
```
{
"message": "Bad Request"
}
```
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"
}
```
application/json Copy Error
```
{
"message": "Unable to find a hosting with given parameters."
}
```
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."
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `hosting_name` required | `string` path | `Test` | Hosting Name |
##### Response `200``application/json`
2 fields
Ok.
| Field | Type | Description |
| --- | --- | --- |
| `code` | `integer` | Status Code. |
| `message` | `object` | Payload |
##### Response `400``application/json`
2 fields
Bad request
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `404``application/json`
1 fields
Error
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | — |
##### Response `500``application/json`
1 fields
The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
### AMI-Storage
`POST` `/share-ami`
#### Share-AMI
`ShareAMI`
Share AMI
Share AMI endpoint
##### Response
200400 application/json400 text/html403500
application/json Copy Ok.
```
{
"code": 200,
"message": "example"
}
```
application/json Copy Bad Request
```
{
"code": "400",
"message": "Bad request."
}
```
text/html Copy Bad Request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
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"
}
```
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."
}
```
##### Response `200``application/json`
2 fields
Ok.
| Field | Type | Description |
| --- | --- | --- |
| `code` | `integer` | Status Code. |
| `message` | `string` | Payload |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Bad request error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `500``application/json`
1 fields
The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
### Host
`POST` `/ami-infos`
#### Create New AMI info
`CreateNewAMIInfo`
Create New AMI info endpoint
##### Request
application/jsonapplication/json
application/json Copy
```
{
"ami_id": "Example AMI",
"ami_name": "Example Instance Type",
"health_check_url": "Example Health Check Url"
}
```
application/json Copy
```
{
"ami_id": null,
"ami_name": null,
"health_check_url": null
}
```
##### Response
200400 application/json400 text/html403500
application/json Copy Ok.
```
{
"code": 200,
"message": "AMI info created successfully"
}
```
application/json Copy Bad Request
```
{
"code": "400",
"message": "Bad request."
}
```
text/html Copy Bad Request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
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"
}
```
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."
}
```
##### Response `200``application/json`
2 fields
Ok.
| Field | Type | Description |
| --- | --- | --- |
| `code` | `integer` | Status Code. |
| `message` | `object` | Payload |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Bad request error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `500``application/json`
1 fields
The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
`GET` `/ami-infos/{ami_name}`
#### Get AMI Info
`GetAMIInfo`
Get AMI Info endpoint
##### Response
200400 application/json400 text/html403404500
application/json Copy Ok.
```
{
"code": 200,
"message": {
"host": "example"
}
}
```
application/json Copy Bad Request
```
{
"code": "400",
"message": "Bad request."
}
```
text/html Copy Bad Request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
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"
}
```
application/json Copy Error
```
{
"message": "Unable to find a ami information with given parameters."
}
```
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."
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `ami_name` required | `string` path | `Test` | AMI Name |
##### Response `200``application/json`
2 fields
Ok.
| Field | Type | Description |
| --- | --- | --- |
| `code` | `integer` | Status Code. |
| `message` | `object` | Payload |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Bad request error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `404``application/json`
1 fields
Error
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | — |
##### Response `500``application/json`
1 fields
The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
`DELETE` `/ami-infos/{ami_name}`
#### Remove AMI Info
`RemoveAMIInfo`
Remove AMI Info endpoint
##### Response
200400 application/json400 text/html403404500
application/json Copy Ok.
```
{
"code": 200,
"message": "Example"
}
```
application/json Copy Bad Request
```
{
"code": "400",
"message": "Bad request."
}
```
text/html Copy Bad Request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
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"
}
```
application/json Copy Error
```
{
"message": "Unable to find a ami information with given parameters."
}
```
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."
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `ami_name` required | `string` path | `Test` | AMI Name |
##### Response `200``application/json`
2 fields
Ok.
| Field | Type | Description |
| --- | --- | --- |
| `code` | `integer` | Status Code. |
| `message` | `object` | Payload |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Bad request error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `404``application/json`
1 fields
Error
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | — |
##### Response `500``application/json`
1 fields
The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
`PUT` `/ami-infos/{ami_name}`
#### Update New AMI info
`UpdateNewAMIInfo`
Update New AMI info endpoint
##### Request
application/jsonapplication/json
application/json Copy
```
{
"ami_id": "Example AMI",
"health_check_url": "Example Health Check Url"
}
```
application/json Copy
```
{
"ami_id": null,
"health_check_url": null
}
```
##### Response
200400 application/json400 text/html403500
application/json Copy Ok.
```
{
"code": 200,
"message": "AMI info updated successfully"
}
```
application/json Copy Bad Request
```
{
"code": "400",
"message": "Bad request."
}
```
text/html Copy Bad Request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
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"
}
```
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."
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `ami_name` required | `string` path | `Test` | AMI Name |
##### Response `200``application/json`
2 fields
Ok.
| Field | Type | Description |
| --- | --- | --- |
| `code` | `integer` | Status Code. |
| `message` | `object` | Payload |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Bad request error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `500``application/json`
1 fields
The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
### SoftworksAI
`POST` `/process-batches`
#### Add New Batch for Processing
`process-tobatches`
Add a new batch for processing.
The service process a batch with one or multiple documents in SoftworksAI. Mortgage documents can be classified and extracted by this service.
Documents can be processed according to the priority specified in the request, you can send High, Medium, and Low.
The batch request will be received and will be in progress, the status of the batch can be got by calling the service /batch-info/{name}, which will provide each generated document status, classification, and ID.
##### Request
application/json Copy An example of a payload.
```
{
"Name": "00-batch-from-api-initial-test-healthy-check-001",
"FileList": [
"https://somebucketname.s3.us-east-1.amazonaws.com/MultiDocs_10_pages.pdf?X-Amz-Algorithm=&X-Amz-Credential=%2F20180210%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=&X-Amz-Expires=1800&X-Amz-Signature=&X-Amz-SignedHeaders=host"
],
"Priority": "High",
"transaction_id": "01FMVZRHRT0B5GWJR5DC36AVWE"
}
```
##### Response
201202400 application/json400 text/html401403422
application/json Copy Created.
```
{
"code": 201,
"message": "IN PROGRESS"
}
```
application/json Copy Accepted.
```
{
"code": 202,
"message": "IN PROGRESS"
}
```
application/json Copy Bad Request
```
{
"code": "400",
"message": "Bad request."
}
```
text/html Copy Bad Request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
application/json Copy Unauthorized.
```
{
"code": "401",
"message": "This token is not valid for this service."
}
```
application/json Copy Forbidden
```
{
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post",
"message": "This key is not valid for this service."
}
```
application/json Copy Unprocessable Entity
```
{
"code": "422",
"message": "Unprocessable Entity."
}
```
##### Request body`application/json`
4 fields
| Field | Type | Description |
| --- | --- | --- |
| `Name`required | `string` | Batch identifier.Example `00-batch-from-api-initial-test-healthy-check-001` |
| `FileList`required | `string[]` | List of files to process. |
| `Priority`required | `string` | Batch processing priority.`High``Low``Medium`Example `High` |
| `transaction_id`required | `string` | Transaction idExample `01FMVZRHRT0B5GWJR5DC36AVWE` |
##### Response `201``application/json`
2 fields
Created.
| Field | Type | Description |
| --- | --- | --- |
| `code` | `integer` | Status Code. |
| `message` | `string` | Description response. |
##### Response `202``application/json`
2 fields
Accepted.
| Field | Type | Description |
| --- | --- | --- |
| `code` | `integer` | Status Code. |
| `message` | `string` | Description response. |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Bad request error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `401``application/json`
1 fields
Unauthorized.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Unauthorized error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `403``application/json`
2 fields
Forbidden
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | The URL. |
| `message` | `string` | Error message. |
##### Response `408``application/json`
1 fields
Request Timeout.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Timeout error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `409``application/json`
1 fields
Conflict
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `422``application/json`
1 fields
Unprocessable Entity
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Unprocessable entity error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `500``application/json`
1 fields
Internal Server Error
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `502``application/json`
1 fields
Bad Gateway
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `503``application/json`
1 fields
Service Unavailable
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
`GET` `/batch-info/{name}`
#### Retrieve Documents Associated with Batch
`batch-info`
Get all docs associated with a batch
This service get all documents processed under a batch name , the current status and document type identified by SoftworksAI.
A document ID is generated under the following scenarios:
- The batch processed has multiple documents with a URL for each.
- One PDF document with multiple pages, each processed page will have its own document ID.
##### Response
200400 application/json400 text/html401403404422
application/json Copy Ok.
```
[
{
"id": 1
},
{
"name": "00-batch-from-api-initial-test-healthy-check-001"
},
{
"stage": "Recognition"
},
{
"status": "processing"
},
{
"assignedTo": "SYSTEM"
},
{
"scannedDate": "3/12/2021 3:14:04 PM"
},
{
"modifiedDate": "3/12/2021 3:14:04 PM"
},
{
"docType": ""
},
{
"tenantName": ""
},
{
"errorMessage": ""
},
{
"FileList": [
"\\\\10.0.0.123\\Workflow\\TrapezeProject\\Pending\\Batches\\00-batch-from-api-initial-test-healthy-check-001\\2.Recognition\\MultiDocs_10_pages_CV20210312151404.pdf"
]
},
{
"Priority": "High"
}
]
```
application/json Copy Bad Request
```
{
"code": "400",
"message": "Bad request."
}
```
text/html Copy Bad Request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
application/json Copy Unauthorized.
```
{
"code": "401",
"message": "This token is not valid for this service."
}
```
application/json Copy Forbidden
```
{
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post",
"message": "This key is not valid for this service."
}
```
application/json Copy Not Found
```
{
"code": "404",
"message": "Not Found."
}
```
application/json Copy Unprocessable Entity
```
{
"code": "422",
"message": "Unprocessable Entity."
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `name` required | `string` path | `00-batch-from-api-initial-test-healthy-check-001` | Name of the batch which extracted data it's being requested. |
##### Response `200``application/json`
16 fields
Ok.
| Field | Type | Description |
| --- | --- | --- |
| `inFileName` | `string` | — |
| `inDocId` | `integer` | — |
| `inNumPages` | `integer` | — |
| `numPages` | `integer` | — |
| `id` | `integer` | — |
| `name` | `string` | — |
| `stage` | `string` | — |
| `status` | `string` | — |
| `assignedTo` | `string` | — |
| `scannedDate` | `string` | — |
| `modifiedDate` | `string` | — |
| `docType` | `string` | — |
| `tenantName` | `string` | — |
| `errorMessage` | `string` | — |
| `FileList` | `string[]` | — |
| `Priority` | `string` | — |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Bad request error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `401``application/json`
1 fields
Unauthorized.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Unauthorized error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `403``application/json`
2 fields
Forbidden
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | The URL. |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Not Found
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Unprocessable entity error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `408``application/json`
1 fields
Request Timeout.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Timeout error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `409``application/json`
1 fields
Conflict
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `422``application/json`
1 fields
Unprocessable Entity
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Unprocessable entity error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `500``application/json`
1 fields
Internal Server Error
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `502``application/json`
1 fields
Bad Gateway
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `503``application/json`
1 fields
Service Unavailable
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
`GET` `/batch-status/{name}`
#### Retrieve Batch Status
`batch-status`
Get batch status
This service get all documents processed under a batch name , the current status and document type identified by SoftworksAI.
A document ID is generated under the following scenarios:
- The batch processed has multiple documents with a URL for each.
- One PDF document with multiple pages, each processed page will have its own document ID.
##### Response
200202400 application/json400 text/html401403404422
application/json Copy Ok.
```
[
{
"id": 1
},
{
"name": "00-batch-from-api-initial-test-healthy-check-001"
},
{
"stage": "Recognition"
},
{
"status": "processing"
},
{
"assignedTo": "SYSTEM"
},
{
"scannedDate": "3/12/2021 3:14:04 PM"
},
{
"modifiedDate": "3/12/2021 3:14:04 PM"
},
{
"docType": ""
},
{
"tenantName": ""
},
{
"errorMessage": ""
},
{
"FileList": [
"\\\\10.0.0.123\\Workflow\\TrapezeProject\\Pending\\Batches\\00-batch-from-api-initial-test-healthy-check-001\\2.Recognition\\MultiDocs_10_pages_CV20210312151404.pdf"
]
},
{
"Priority": "High"
}
]
```
application/json Copy Ok.
```
[
{
"id": 1
},
{
"name": "00-batch-from-api-initial-test-healthy-check-001"
},
{
"stage": "Recognition"
},
{
"status": "processing"
},
{
"assignedTo": "SYSTEM"
},
{
"scannedDate": "3/12/2021 3:14:04 PM"
},
{
"modifiedDate": "3/12/2021 3:14:04 PM"
},
{
"docType": ""
},
{
"tenantName": ""
},
{
"errorMessage": ""
},
{
"FileList": [
"\\\\10.0.0.123\\Workflow\\TrapezeProject\\Pending\\Batches\\00-batch-from-api-initial-test-healthy-check-001\\2.Recognition\\MultiDocs_10_pages_CV20210312151404.pdf"
]
},
{
"Priority": "High"
}
]
```
application/json Copy Bad Request
```
{
"code": "400",
"message": "Bad request."
}
```
text/html Copy Bad Request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
application/json Copy Unauthorized.
```
{
"code": "401",
"message": "This token is not valid for this service."
}
```
application/json Copy Forbidden
```
{
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post",
"message": "This key is not valid for this service."
}
```
application/json Copy Not Found
```
{
"code": "404",
"message": "Not Found."
}
```
application/json Copy Unprocessable Entity
```
{
"code": "422",
"message": "Unprocessable Entity."
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `name` required | `string` path | `00-batch-from-api-initial-test-healthy-check-001` | Name of the batch which extracted data it's being requested. |
##### Response `200``application/json`
12 fields
Ok.
| Field | Type | Description |
| --- | --- | --- |
| `id` | `integer` | — |
| `name` | `string` | — |
| `stage` | `string` | — |
| `status` | `string` | — |
| `assignedTo` | `string` | — |
| `scannedDate` | `string` | — |
| `modifiedDate` | `string` | — |
| `docType` | `string` | — |
| `tenantName` | `string` | — |
| `errorMessage` | `string` | — |
| `FileList` | `string[]` | — |
| `Priority` | `string` | — |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Bad request error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `401``application/json`
1 fields
Unauthorized.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Unauthorized error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `403``application/json`
2 fields
Forbidden
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | The URL. |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Not Found
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Unprocessable entity error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `408``application/json`
1 fields
Request Timeout.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Timeout error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `409``application/json`
1 fields
Conflict
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `422``application/json`
1 fields
Unprocessable Entity
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Unprocessable entity error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `500``application/json`
1 fields
Internal Server Error
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `502``application/json`
1 fields
Bad Gateway
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `503``application/json`
1 fields
Service Unavailable
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Other responses
`202`
`GET` `/extract/batch-name/{name}`
#### Retrieve List of Extracted Fields
`extract-all`
Get list of extracted fields
This service returns all extracted documents for one batch in SoftworksAI. For documents with multiple pages, this service returns all documents extracted as well.
##### Response
200400 application/json400 text/html401403404422
application/json Copy Ok.
```
[
{
"fieldlist": [
{
"position": [
{
"page": 1
},
{
"inputFilePageNumber": 1
},
{
"inputFileID": 10015
},
{
"top": 0
},
{
"bottom": 0
},
{
"left": 0
},
{
"right": 0
}
]
},
{
"name": "DocumentType"
},
{
"data": "W-2"
},
{
"dataOriginal": "W-2"
},
{
"conf": 100
}
]
},
{
"id": 10023
},
{
"docType": "W-2"
},
{
"docConf": 93
}
]
```
application/json Copy Bad Request
```
{
"code": "400",
"message": "Bad request."
}
```
text/html Copy Bad Request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
application/json Copy Unauthorized.
```
{
"code": "401",
"message": "This token is not valid for this service."
}
```
application/json Copy Forbidden
```
{
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post",
"message": "This key is not valid for this service."
}
```
application/json Copy Not Found
```
{
"code": "404",
"message": "Not Found."
}
```
application/json Copy Unprocessable Entity
```
{
"code": "422",
"message": "Unprocessable Entity."
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `name` required | `string` path | `00-batch-from-api-initial-test-healthy-check-001` | Name of the batch which extracted data it's being requested. |
##### Response `200``application/json`
4 fields
Ok.
| Field | Type | Description |
| --- | --- | --- |
| `fieldList` | `object[]` | — |
| `position` | `object[]` | — |
| `page` | `integer` | — |
| `inputFilePageNumber` | `integer` | — |
| `inputFileID` | `integer` | — |
| `top` | `integer` | — |
| `bottom` | `integer` | — |
| `left` | `integer` | — |
| `right` | `integer` | — |
| `name` | `string` | — |
| `data` | `string` | — |
| `dataOriginal` | `string` | — |
| `conf` | `integer` | — |
| `id` | `integer` | — |
| `docType` | `string` | — |
| `docConf` | `integer` | — |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Bad request error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `401``application/json`
1 fields
Unauthorized.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Unauthorized error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `403``application/json`
2 fields
Forbidden
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | The URL. |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Not Found
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Unprocessable entity error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `408``application/json`
1 fields
Request Timeout.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Timeout error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `409``application/json`
1 fields
Conflict
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `422``application/json`
1 fields
Unprocessable Entity
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Unprocessable entity error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `500``application/json`
1 fields
Internal Server Error
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `502``application/json`
1 fields
Bad Gateway
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `503``application/json`
1 fields
Service Unavailable
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
`PUT` `/{name}/pages`
#### Update And Approve Pages
`updateAndApprovePages`
The service updates And approves pages
##### Request
application/json Copy An example of a payload.
```
[
{
"id": 124,
"docID": 31,
"pageNumber": 1,
"docType": "Form 1003 Uniform Residential Loan Application",
"docConf": 94,
"confThresh": 90,
"split": true,
"outputDocId": 1,
"inputFilePageNumber": 2
}
]
```
##### Response
200400 application/json400 text/html401403422
application/json Copy Ok.
```
{
"code": 200,
"message": "Configuration updated successfully"
}
```
application/json Copy Bad Request
```
{
"code": "400",
"message": "Bad request."
}
```
text/html Copy Bad Request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
application/json Copy Unauthorized.
```
{
"code": "401",
"message": "This token is not valid for this service."
}
```
application/json Copy Forbidden
```
{
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post",
"message": "This key is not valid for this service."
}
```
application/json Copy Unprocessable Entity
```
{
"code": "422",
"message": "Unprocessable Entity."
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `name` required | `string` path | `00-batch-from-api-initial-test-healthy-check-001` | Name of the batch which extracted data it's being requested. |
##### Response `200``application/json`
2 fields
Ok.
| Field | Type | Description |
| --- | --- | --- |
| `code` | `integer` | Status Code. |
| `message` | `string` | Status message. |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Bad request error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `401``application/json`
1 fields
Unauthorized.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Unauthorized error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `403``application/json`
2 fields
Forbidden
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | The URL. |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Not Found.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Not Found. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `422``application/json`
1 fields
Unprocessable Entity
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Unprocessable entity error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `500``application/json`
1 fields
Internal Server Error
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `502``application/json`
1 fields
Bad Gateway
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `503``application/json`
1 fields
Service Unavailable
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
`GET` `/{name}/pages`
#### Get Pages
`getPages`
The service gets pages for the batch
##### Response
200400 application/json400 text/html401403422
application/json Copy Ok.
```
[
{
"id": 167,
"docID": 6,
"pageNumber": 1,
"docType": "Miscellaneous",
"docConf": 52,
"confThresh": 75,
"split": true,
"outputDocId": 0,
"inputFilePageNumber": 1,
"filePath": ""
}
]
```
application/json Copy Bad Request
```
{
"code": "400",
"message": "Bad request."
}
```
text/html Copy Bad Request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
application/json Copy Unauthorized.
```
{
"code": "401",
"message": "This token is not valid for this service."
}
```
application/json Copy Forbidden
```
{
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post",
"message": "This key is not valid for this service."
}
```
application/json Copy Unprocessable Entity
```
{
"code": "422",
"message": "Unprocessable Entity."
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `name` required | `string` path | `00-batch-from-api-initial-test-healthy-check-001` | Name of the batch which extracted data it's being requested. |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Bad request error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `401``application/json`
1 fields
Unauthorized.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Unauthorized error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `403``application/json`
2 fields
Forbidden
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | The URL. |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Not Found.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Not Found. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `422``application/json`
1 fields
Unprocessable Entity
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Unprocessable entity error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `500``application/json`
1 fields
Internal Server Error
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `502``application/json`
1 fields
Bad Gateway
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `503``application/json`
1 fields
Service Unavailable
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Other responses
`200`
`GET` `/document_types`
#### Get Document Types
`getDocumentTypes`
The service gets document types
##### Response
200400 application/json400 text/html401403422
application/json Copy Ok.
```
[
"W2"
]
```
application/json Copy Bad Request
```
{
"code": "400",
"message": "Bad request."
}
```
text/html Copy Bad Request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
application/json Copy Unauthorized.
```
{
"code": "401",
"message": "This token is not valid for this service."
}
```
application/json Copy Forbidden
```
{
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post",
"message": "This key is not valid for this service."
}
```
application/json Copy Unprocessable Entity
```
{
"code": "422",
"message": "Unprocessable Entity."
}
```
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Bad request error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `401``application/json`
1 fields
Unauthorized.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Unauthorized error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `403``application/json`
2 fields
Forbidden
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | The URL. |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Not Found.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Not Found. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `422``application/json`
1 fields
Unprocessable Entity
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Unprocessable entity error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `500``application/json`
1 fields
Internal Server Error
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `502``application/json`
1 fields
Bad Gateway
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `503``application/json`
1 fields
Service Unavailable
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Other responses
`200`
`GET` `/document_types/{document_type}/fields`
#### Get Fields
`getFields`
The service gets fields
##### Response
200400 application/json400 text/html401403422
application/json Copy Ok.
```
[
{
"fieldList": [
{
"position": {
"page": 1,
"inputFilePageNumber": 1,
"inputFileID": 2,
"top": 0,
"bottom": 0,
"left": 0,
"right": 0
},
"name": "DocumentType",
"data": "Form 1008 Uniform Underwriting and Transmittal Summary",
"dataOriginal": "Form 1008 Uniform Underwriting and Transmittal Summary",
"conf": 103
}
],
"id": 21,
"docType": "Form 1004C Manufactured Home Appraisal",
"docConf": 89
}
]
```
application/json Copy Bad Request
```
{
"code": "400",
"message": "Bad request."
}
```
text/html Copy Bad Request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
application/json Copy Unauthorized.
```
{
"code": "401",
"message": "This token is not valid for this service."
}
```
application/json Copy Forbidden
```
{
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post",
"message": "This key is not valid for this service."
}
```
application/json Copy Unprocessable Entity
```
{
"code": "422",
"message": "Unprocessable Entity."
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `document_type` required | `string` path | `W2` | Document Type |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Bad request error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `401``application/json`
1 fields
Unauthorized.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Unauthorized error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `403``application/json`
2 fields
Forbidden
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | The URL. |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Not Found.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Not Found. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `422``application/json`
1 fields
Unprocessable Entity
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Unprocessable entity error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `500``application/json`
1 fields
Internal Server Error
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `502``application/json`
1 fields
Bad Gateway
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `503``application/json`
1 fields
Service Unavailable
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Other responses
`200`
### Images
`GET` `/images`
#### Get Supported Images
`GetSupportedImages`
Get Supported Images endpoint
##### Response
200400403500
application/json Copy Ok.
```
{
"code": 200,
"message": [
{
"image_name": "host-example",
"suggested_instance_type": "t2.xlarge",
"rules": {
"auto_shutdown": true,
"manual_start": true,
"manual_shutdown": true,
"rdp_access": true,
"auto_start": false
}
}
]
}
```
application/json Copy Bad request
```
{
"message": "Bad Request"
}
```
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"
}
```
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."
}
```
##### Response `200``application/json`
2 fields
Ok.
| Field | Type | Description |
| --- | --- | --- |
| `code` | `integer` | Status Code. |
| `message` | `array` | Payload |
##### Response `400``application/json`
2 fields
Bad request
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `500``application/json`
1 fields
The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
### Actions
`POST` `/hostings/{hosting_name}/start`
#### Hosting Start
`StartHosting`
Start Hosting endpoint
##### Response
200400403404500
application/json Copy Ok.
```
{
"code": 200,
"message": {
"info": "example"
}
}
```
application/json Copy Bad request
```
{
"message": "Bad Request"
}
```
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"
}
```
application/json Copy Error
```
{
"message": "Unable to find a hosting with given parameters."
}
```
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."
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `hosting_name` required | `string` path | `Test` | Hosting Name |
##### Response `200``application/json`
2 fields
Ok.
| Field | Type | Description |
| --- | --- | --- |
| `code` | `integer` | Status Code. |
| `message` | `object` | Payload |
##### Response `400``application/json`
2 fields
Bad request
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `404``application/json`
1 fields
Error
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | — |
##### Response `500``application/json`
1 fields
The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
`POST` `/hostings/{hosting_name}/stop`
#### Hosting Stop
`StopHosting`
Stop Hosting endpoint
##### Response
200400403404500
application/json Copy Ok.
```
{
"code": 200,
"message": {
"info": "example"
}
}
```
application/json Copy Bad request
```
{
"message": "Bad Request"
}
```
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"
}
```
application/json Copy Error
```
{
"message": "Unable to find a hosting with given parameters."
}
```
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."
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `hosting_name` required | `string` path | `Test` | Hosting Name |
##### Response `200``application/json`
2 fields
Ok.
| Field | Type | Description |
| --- | --- | --- |
| `code` | `integer` | Status Code. |
| `message` | `object` | Payload |
##### Response `400``application/json`
2 fields
Bad request
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `404``application/json`
1 fields
Error
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | — |
##### Response `500``application/json`
1 fields
The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
`GET` `/hostings/{hosting_name}/rdp_access`
#### Get RDP Access
`GetRDPAccess`
Get RDP Access endpoint
##### Response
200400403500
application/json Copy Ok.
```
[
"Example"
]
```
application/json Copy Bad request
```
{
"message": "Bad Request"
}
```
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"
}
```
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."
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `hosting_name` required | `string` path | `Test` | Hosting Name |
##### Response `400``application/json`
2 fields
Bad request
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `403``application/json`
2 fields
Invalid key for service
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
| `url` | `string` | — |
##### Response `500``application/json`
1 fields
The product has encountered an internal server error. If possible, please contact Staircase support with the transaction_id you used.
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | — |
##### Other responses
`200`
### Operations
`GET` `/get-base-url`
#### Get Base URL
`get-base-url-ephesoft`
Provides a base URL to interact with the current installation of Ephesoft web service.
##### Response
200403
application/json Copy Ok.
```
{
"base_url": "http://host-Publi-XXXXXXXXXXXX-1838739269.us-east-1.elb.amazonaws.com:8300"
}
```
application/json Copy Forbidden
```
{
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post",
"message": "This key is not valid for this service."
}
```
##### Response `200``application/json`
1 fields
Ok.
| Field | Type | Description |
| --- | --- | --- |
| `base_url` | `string` | Base URL that can be hit in order to interact with Ephesoft AI’s API. |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error`required | `string` | Error message. |
##### Response `403``application/json`
2 fields
Forbidden
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | The URL. |
| `message` | `string` | Error message. |
##### Response `500``application/json`
1 fields
Batch job creation failure.
| Field | Type | Description |
| --- | --- | --- |
| `error`required | `string` | Error message. |
##### Other responses
`401`
`GET` `/get-license-requirement`
#### Get information to request new license
`get-license-requirement`
Ephesoft partner requires a file and Installation details to request a license from the support portal. This service gets the details needed to request a new license and returns a presigned URL with the document to download.
License portal to get a license from Ephesoft:
##### Response
200400
application/json Copy Ok.
```
{
"total_cores": 2,
"product_version": "2020.1",
"server_os_details": "Microsoft® Windows",
"mac_address": "00:AA:BB:CC:DD",
"database_detail": "DB",
"system_memory": "1GB",
"detail_properties_file": "http://host-Publi-XXXXXXXXXXXX-1838739269.us-east-1.elb.amazo"
}
```
application/json Copy Bad Request
```
{
"code": "400",
"message": "Bad request."
}
```
##### Parameters
2
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Key used to identify the API usage plan |
| `Content-Type` required | `string` header | `application/json` | The content type. |
##### Response `200``application/json`
7 fields
Ok.
| Field | Type | Description |
| --- | --- | --- |
| `total_cores` | `number` | Total cores for your specific environment |
| `product_Error description` | `string` | Version of Ephesoft |
| `server_os_details` | `string` | SO that is currently used for your Ephesoft product |
| `mac_address` | `string` | All mac address that you need to request a license before your complete an installation |
| `database_detail` | `string` | Version of database |
| `system_memory` | `string` | Total memory for server |
| `detail_properties_file` | `string` | URL of request license file |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Bad request error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
##### Response `500``application/json`
1 fields
Internal Server Error
| Field | Type | Description |
| --- | --- | --- |
| `error` | `object` | Conflict error. |
| `code`required | `string` | Error name. |
| `message`required | `string` | Error description. |
## Providers
- Byte Software
- Ephesoft
- SoftworksAI
## Errors
`400``401``403``404``408``409``422``500``502``503`
## More in Distribution
- Previous product: Finance
- Next product: Marketplace