Skip to content
/
Testing endpoints for Pos...

Compliance features (1.0)

Download OpenAPI description
compliance.json
compliance.yaml
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/onboarding/compliance/

AML follow-up

Operations

Testing endpoints for Postbox API

Operations

Upload a document and create a Postbox item for a person

Request

Uploads a document and creates a Postbox item for the person specified in the request URL.
To pass the Postbox item details, you may use either the metadata object or separate request parts (i.e., the request properties document_name, document_type, etc.) If you use the second option, you must set the Content-Type of boolean properties to application/json.

Path
person_idstringrequired

ID of the person.

Bodymultipart/form-datarequired
filestring(binary)

The file to upload.

metadataobject

Object containing metadata related to the document.

document_namestring

Name of the document.

Example: "account_statement_01_04_2023_12365.pdf"
document_descriptionstring

Description of the document.

Example: "Account statement for 01_04_2023 for the customer 12365"
document_typestring

The type of document associated with the Postbox item.

Enum"ACCOUNT_STATEMENT""ASSETS_ACQUISITION_COSTS""ASSETS_ACQUISITION""BALANCE_CONFIRMATION""CREDIT_CARD_CONTRACT_SIGNED""CREDIT_CARD_CONTRACT""CREDIT_CARD_SECCI""CREDIT_CARD_STATEMENT""CUSTOMER_INFORMATION""DEPOT_STATEMENT_MIFID"
document_datestring

The date of the document associated with the Postbox item.

Example: "2024-07-30"
idempotency_keystring

Optional property you may supply to prevent the execution of duplicate requests. If the API receives a request with a previously used idempotency key, then it will return the previously created entity.

sign_documentboolean

(Optional) If set to true, then the document will be signed. Please note that you must use Content-Type: application/json for boolean properties in this request.

customer_notificationboolean

Boolean value to indicate whether or not customers should receive a notification when the Postbox item is created. Please note that you must use Content-Type: application/json for boolean properties in this request.

customer_confirmationboolean

Boolean value to indicate whether or not customers must confirm the Postbox item. Please note that you must use Content-Type: application/json for boolean properties in this request.

multipart/form-data
{
  "file": "string",
  "metadata": {
    "document_name": "account_statement_01_04_2023_12365.pdf",
    "document_description": "Account statement for 01_04_2023 for the customer 12365",
    "document_type": "CREDIT_CARD_STATEMENT",
    "document_date": "2024-07-30",
    "idempotency_key": "string",
    "sign_document": true,
    "customer_notification": true,
    "customer_confirmation": true
  },
  "document_name": "account_statement_01_04_2023_12365.pdf",
  "document_description": "Account statement for 01_04_2023 for the customer 12365",
  "document_type": "ACCOUNT_STATEMENT",
  "document_date": "2024-07-30",
  "idempotency_key": "string",
  "sign_document": true,
  "customer_notification": true,
  "customer_confirmation": true
}

Responses

The Postbox document and its item were created successfully.

Bodyapplication/json
idstring

ID of the Postbox item.

belongs_tostring

ID of the person or business with whom the Postbox item is associated.

owner_typestring

Indicates whether the Postbox item is owned by a person or business.

Enum"Person""Business"
created_atstring

UTC timestamp from when the Postbox item was created.

document_datestring

The date of the document associated with the Postbox item.

document_typestring

The type of document associated with the Postbox item.

Enum"ACCOUNT_STATEMENT""BALANCE_CONFIRMATION""CUSTOMER_INFORMATION""DUNNING_INFORMATION""LOAN_SCHEDULE""SECURITIES_INVOICE""SECURITIES_EVENT""SECURITIES_EVENT_NOTIFICATION""DEPOT_STATEMENT_MIFID""EX_POST_COST_INFORMATION"
namestring

The name of the Postbox item.

descriptionstring

A description for the Postbox item.

customer_notificationboolean

Boolean value to indicate whether or not customers should receive a notification when the Postbox item is created.

customer_confirmationboolean

Boolean value to indicate whether or not customers must confirm the Postbox item.

document_sizeinteger(int64)

The file size of the associated document.

document_content_typestring

The content type of the associated document.

document_idstring

The ID of the associated document.

has_been_readboolean

The item was marked as read via patch endpoint.

has_been_confirmedboolean

The item has at least 1 confirmation.

reference_idstring

Reference of original source of a document, e.g. bill_id for credit card statement

Response
application/json
{
  "id": "c072c6e43f4d486cb553e9cd9fc1bae7pbxi",
  "belongs_to": "12345",
  "created_at": "2021-10-22T05:23:30Z",
  "document_date": "2021-06-30",
  "document_type": "BALANCE_CONFIRMATION",
  "name": "Balance confirmation for June 2021",
  "description": "Balance confirmation",
  "customer_notification": false,
  "customer_confirmation": false,
  "document_size": 66092,
  "document_content_type": "image/jpeg",
  "document_id": "e953cbf8af064839b3e3bf2568d1130fpbxd",
  "has_been_read": false,
  "has_been_confirmed": false
}

Upload a document and create a Postbox item for a business

Request

Uploads a document and creates a Postbox item for the business specified in the request URL.
To pass the Postbox item details, you may use either the metadata object or separate request parts (i.e., the request properties document_name, document_type, etc.) If you use the second option, you must set the Content-Type of boolean properties to application/json.

Path
business_idstringrequired

ID of the business.

Bodymultipart/form-datarequired
filestring(binary)

The file to upload.

metadataobject

Object containing metadata related to the document.

document_namestring

Name of the document.

Example: "account_statement_01_04_2023_12365.pdf"
document_descriptionstring

Description of the document.

Example: "Account statement for 01_04_2023 for the customer 12365"
document_typestring

The type of document associated with the Postbox item.

Enum"ACCOUNT_STATEMENT""ASSETS_ACQUISITION_COSTS""ASSETS_ACQUISITION""BALANCE_CONFIRMATION""CREDIT_CARD_CONTRACT_SIGNED""CREDIT_CARD_CONTRACT""CREDIT_CARD_SECCI""CREDIT_CARD_STATEMENT""CUSTOMER_INFORMATION""DEPOT_STATEMENT_MIFID"
document_datestring

The date of the document associated with the Postbox item.

Example: "2024-07-30"
idempotency_keystring

Optional property you may supply to prevent the execution of duplicate requests. If the API receives a request with a previously used idempotency key, then it will return the previously created entity.

sign_documentboolean

(Optional) If set to true, then the document will be signed. Please note that you must use Content-Type: application/json for boolean properties in this request.

customer_notificationboolean

Boolean value to indicate whether or not customers should receive a notification when the Postbox item is created. Please note that you must use Content-Type: application/json for boolean properties in this request.

customer_confirmationboolean

Boolean value to indicate whether or not customers must confirm the Postbox item. Please note that you must use Content-Type: application/json for boolean properties in this request.

multipart/form-data
{
  "file": "string",
  "metadata": {
    "document_name": "account_statement_01_04_2023_12365.pdf",
    "document_description": "Account statement for 01_04_2023 for the customer 12365",
    "document_type": "CREDIT_CARD_STATEMENT",
    "document_date": "2024-07-30",
    "idempotency_key": "string",
    "sign_document": true,
    "customer_notification": true,
    "customer_confirmation": true
  },
  "document_name": "account_statement_01_04_2023_12365.pdf",
  "document_description": "Account statement for 01_04_2023 for the customer 12365",
  "document_type": "ACCOUNT_STATEMENT",
  "document_date": "2024-07-30",
  "idempotency_key": "string",
  "sign_document": true,
  "customer_notification": true,
  "customer_confirmation": true
}

Responses

The Postbox document and its item were created successfully.

Bodyapplication/json
idstring

ID of the Postbox item.

belongs_tostring

ID of the person or business with whom the Postbox item is associated.

owner_typestring

Indicates whether the Postbox item is owned by a person or business.

Enum"Person""Business"
created_atstring

UTC timestamp from when the Postbox item was created.

document_datestring

The date of the document associated with the Postbox item.

document_typestring

The type of document associated with the Postbox item.

Enum"ACCOUNT_STATEMENT""BALANCE_CONFIRMATION""CUSTOMER_INFORMATION""DUNNING_INFORMATION""LOAN_SCHEDULE""SECURITIES_INVOICE""SECURITIES_EVENT""SECURITIES_EVENT_NOTIFICATION""DEPOT_STATEMENT_MIFID""EX_POST_COST_INFORMATION"
namestring

The name of the Postbox item.

descriptionstring

A description for the Postbox item.

customer_notificationboolean

Boolean value to indicate whether or not customers should receive a notification when the Postbox item is created.

customer_confirmationboolean

Boolean value to indicate whether or not customers must confirm the Postbox item.

document_sizeinteger(int64)

The file size of the associated document.

document_content_typestring

The content type of the associated document.

document_idstring

The ID of the associated document.

has_been_readboolean

The item was marked as read via patch endpoint.

has_been_confirmedboolean

The item has at least 1 confirmation.

reference_idstring

Reference of original source of a document, e.g. bill_id for credit card statement

Response
application/json
{
  "id": "c072c6e43f4d486cb553e9cd9fc1bae7pbxi",
  "belongs_to": "12345",
  "created_at": "2021-10-22T05:23:30Z",
  "document_date": "2021-06-30",
  "document_type": "BALANCE_CONFIRMATION",
  "name": "Balance confirmation for June 2021",
  "description": "Balance confirmation",
  "customer_notification": false,
  "customer_confirmation": false,
  "document_size": 66092,
  "document_content_type": "image/jpeg",
  "document_id": "e953cbf8af064839b3e3bf2568d1130fpbxd",
  "has_been_read": false,
  "has_been_confirmed": false
}

Generate a PDF document

Request

Generates an empty PDF document on Solaris' servers for use as a Postbox item. Please note the following:

  • The Content-Type header for this request must be application/json.
  • This endpoint can only be used for testing purposes on the testing, staging, and sandbox environments.

Bodyapplication/jsonrequired
document_datestringrequired

The date of the document.

document_typestringrequired

The type of document.

Enum"ACCOUNT_STATEMENT""BALANCE_CONFIRMATION""CUSTOMER_INFORMATION""DUNNING_INFORMATION""LOAN_SCHEDULE""SECURITIES_INVOICE""SECURITIES_EVENT""SECURITIES_EVENT_NOTIFICATION""DEPOT_STATEMENT_MIFID""EX_POST_COST_INFORMATION"
sign_documentboolean

(Optional) If set to true, then the document will be signed.

application/json
{
  "document_type": "ACCOUNT_STATEMENT",
  "document_date": "string",
  "sign_document": true
}

Responses

The document was created successfully.

Bodyapplication/json
idstring
Response
application/json
{
  "id": "cd5b907fd34e21044f0421a430c9b640psbd"
}

Create a Postbox item for a personDeprecated

Request

Deprecated! Use POST /v1/persons/{person_id}/postbox instead.
Creates a Postbox item for the person specified in the request URL. Note that you can only use this endpoint for testing purposes on the testing, staging, and sandbox environments.

Path
person_idstringrequired

Person Id.

Bodyapplication/jsonrequired
namestring

The name to apply to the Postbox item.

descriptionstring

A description for the Postbox item.

customer_notificationboolean

Boolean value to indicate whether or not customers should receive a notification when the Postbox item is created.

customer_confirmationboolean

Boolean value to indicate whether or not customers must confirm the Postbox item.

document_idstring

ID of a document to associate with the Postbox item. Use the POST /v1/postbox_documents endpoint to upload test documents.

idempotency_keystring

Optional property you may supply to prevent the execution of duplicate requests. If the API receives a request with a previously used idempotency key, then it will return the previously created entity.

application/json
{
  "name": "string",
  "description": "string",
  "customer_notification": true,
  "customer_confirmation": true,
  "document_id": "string",
  "idempotency_key": "string"
}

Responses

The Postbox item was created successfully.

Bodyapplication/json
idstring

ID of the Postbox item.

belongs_tostring

ID of the person or business with whom the Postbox item is associated.

owner_typestring

Indicates whether the Postbox item is owned by a person or business.

Enum"Person""Business"
created_atstring

UTC timestamp from when the Postbox item was created.

document_datestring

The date of the document associated with the Postbox item.

document_typestring

The type of document associated with the Postbox item.

Enum"ACCOUNT_STATEMENT""BALANCE_CONFIRMATION""CUSTOMER_INFORMATION""DUNNING_INFORMATION""LOAN_SCHEDULE""SECURITIES_INVOICE""SECURITIES_EVENT""SECURITIES_EVENT_NOTIFICATION""DEPOT_STATEMENT_MIFID""EX_POST_COST_INFORMATION"
namestring

The name of the Postbox item.

descriptionstring

A description for the Postbox item.

customer_notificationboolean

Boolean value to indicate whether or not customers should receive a notification when the Postbox item is created.

customer_confirmationboolean

Boolean value to indicate whether or not customers must confirm the Postbox item.

document_sizeinteger(int64)

The file size of the associated document.

document_content_typestring

The content type of the associated document.

document_idstring

The ID of the associated document.

has_been_readboolean

The item was marked as read via patch endpoint.

has_been_confirmedboolean

The item has at least 1 confirmation.

reference_idstring

Reference of original source of a document, e.g. bill_id for credit card statement

Response
application/json
{
  "id": "c072c6e43f4d486cb553e9cd9fc1bae7pbxi",
  "belongs_to": "12345",
  "created_at": "2021-10-22T05:23:30Z",
  "document_date": "2021-06-30",
  "document_type": "BALANCE_CONFIRMATION",
  "name": "Balance confirmation for June 2021",
  "description": "Balance confirmation",
  "customer_notification": false,
  "customer_confirmation": false,
  "document_size": 66092,
  "document_content_type": "image/jpeg",
  "document_id": "e953cbf8af064839b3e3bf2568d1130fpbxd",
  "has_been_read": false,
  "has_been_confirmed": false
}

Create a Postbox item for a businessDeprecated

Request

Deprecated! Use POST /v1/businesses/{business_id}/postbox instead.
Creates a Postbox item for the business specified in the request URL. Note that you can only use this endpoint for testing purposes on the testing, staging, and sandbox environments.

Path
business_idstringrequired

ID of the business.

Bodyapplication/jsonrequired
namestring

The name to apply to the Postbox item.

descriptionstring

A description for the Postbox item.

customer_notificationboolean

Boolean value to indicate whether or not customers should receive a notification when the Postbox item is created.

customer_confirmationboolean

Boolean value to indicate whether or not customers must confirm the Postbox item.

document_idstring

ID of a document to associate with the Postbox item. Use the POST /v1/postbox_documents endpoint to upload test documents.

idempotency_keystring

Optional property you may supply to prevent the execution of duplicate requests. If the API receives a request with a previously used idempotency key, then it will return the previously created entity.

application/json
{
  "name": "string",
  "description": "string",
  "customer_notification": true,
  "customer_confirmation": true,
  "document_id": "string",
  "idempotency_key": "string"
}

Responses

The Postbox item was created successfully.

Bodyapplication/json
idstring

ID of the Postbox item.

belongs_tostring

ID of the person or business with whom the Postbox item is associated.

owner_typestring

Indicates whether the Postbox item is owned by a person or business.

Enum"Person""Business"
created_atstring

UTC timestamp from when the Postbox item was created.

document_datestring

The date of the document associated with the Postbox item.

document_typestring

The type of document associated with the Postbox item.

Enum"ACCOUNT_STATEMENT""BALANCE_CONFIRMATION""CUSTOMER_INFORMATION""DUNNING_INFORMATION""LOAN_SCHEDULE""SECURITIES_INVOICE""SECURITIES_EVENT""SECURITIES_EVENT_NOTIFICATION""DEPOT_STATEMENT_MIFID""EX_POST_COST_INFORMATION"
namestring

The name of the Postbox item.

descriptionstring

A description for the Postbox item.

customer_notificationboolean

Boolean value to indicate whether or not customers should receive a notification when the Postbox item is created.

customer_confirmationboolean

Boolean value to indicate whether or not customers must confirm the Postbox item.

document_sizeinteger(int64)

The file size of the associated document.

document_content_typestring

The content type of the associated document.

document_idstring

The ID of the associated document.

has_been_readboolean

The item was marked as read via patch endpoint.

has_been_confirmedboolean

The item has at least 1 confirmation.

reference_idstring

Reference of original source of a document, e.g. bill_id for credit card statement

Response
application/json
{
  "id": "c072c6e43f4d486cb553e9cd9fc1bae7pbxi",
  "belongs_to": "12345",
  "created_at": "2021-10-22T05:23:30Z",
  "document_date": "2021-06-30",
  "document_type": "BALANCE_CONFIRMATION",
  "name": "Balance confirmation for June 2021",
  "description": "Balance confirmation",
  "customer_notification": false,
  "customer_confirmation": false,
  "document_size": 66092,
  "document_content_type": "image/jpeg",
  "document_id": "e953cbf8af064839b3e3bf2568d1130fpbxd",
  "has_been_read": false,
  "has_been_confirmed": false
}

Postbox Items

Operations

Postbox Confirmations

Operations

Questions and Answers

Operations

Terms and Conditions events

Operations