Skip to content
/Postbox Confirmations

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

Postbox Items

Operations

Postbox Confirmations

Operations

Create a confirmation for a Postbox item

Request

Creates a confirmation for the Postbox item specified in the request URL and sets 'has_been_confirmed' to true for the item

Path
item_idstringrequired

ID of the Postbox item.

Bodyapplication/jsonrequired
person_idstring

ID of the person who is confirming the Postbox item.

Example: "28a2197ff6e04a05b6316f83a38ccper"
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 confirmation.

application/json
{
  "person_id": "28a2197ff6e04a05b6316f83a38ccper",
  "idempotency_key": "string"
}

Responses

The confirmation was created successfully.

Bodyapplication/json
idstring

ID of the confirmation.

person_idstring

ID of the person who confirmed the Postbox item.

confirmed_atstring

UTC timestamp from when the person confirmed the Postbox item.

Response
application/json
{
  "id": "c072c6e43f4d486cb553e9cd9fc1bae7pbxc",
  "person_id": "cd5b907fd34e21044f0421a430c9b640cper"
}

Index confirmations associated with a Postbox item

Request

Returns an array containing all confirmations associated with the Postbox item specified in the request URL.
Note that you can filter the results by created_at (min or max) and document_type—see the descriptions below.

Path
item_idstringrequired

ID of the item whose confirmations should be returned.

Query
filter[created_at][min]string(date-time)

Filters the response by Postbox items created from a certain date (i.e., the minimum date in the past when the document was created).

filter[created_at][max]string(date-time)

Filters the response by Postbox items created up until a certain date (i.e., the maximum date in the past when the document was created).

page[number]integer

The number of pages of results to return.

Default 0
page[size]integer

The amount of entries to return on a single page.

Default 10
No request payload

Responses

The confirmations were fetched successfully.

Headers
per-pagestring

The amount of confirmations in a single page.

totalstring

The total amount of confirmations returned for the given request.

linkstring

Links to first/previous/next/last pages.

Bodyapplication/jsonArray [
idstring

ID of the confirmation.

person_idstring

ID of the person who confirmed the Postbox item.

confirmed_atstring

UTC timestamp from when the person confirmed the Postbox item.

]
Response
application/json
[
  {
    "id": "c072c6e43f4d486cb553e9cd9fc1bae7pbxc",
    "person_id": "cd5b907fd34e21044f0421a430c9b640cper",
    "confirmed_at": "2021-10-23T00:00:00Z"
  },
  {
    "id": "c072c6e43f4d486cb553e9cd9fc1bae7pbxc",
    "person_id": "cd5b907fd34e21044f0421a430c9b640cper",
    "confirmed_at": "2021-10-23T00:00:00Z"
  }
]

Retrieve a confirmation

Request

Returns the confirmation specified in the request URL.

Path
item_idstringrequired

ID of the Postbox item with which the confirmation is associated.

confirmation_idstringrequired

ID of the confirmation.

No request payload

Responses

The confirmation was fetched successfully.

Bodyapplication/json
idstring

ID of the confirmation.

person_idstring

ID of the person who confirmed the Postbox item.

confirmed_atstring

UTC timestamp from when the person confirmed the Postbox item.

Response
application/json
{
  "id": "c072c6e43f4d486cb553e9cd9fc1bae7pbxc",
  "person_id": "cd5b907fd34e21044f0421a430c9b640cper",
  "confirmed_at": "2021-10-23T00:00:00Z"
}

Questions and Answers

Operations

Terms and Conditions events

Operations