Skip to content
/Questions and Answers

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

Questions and Answers

Operations

Create an answer to a question

Request

Creates an answer to the question specified in the request URL by its ID.
Please note the following:

  • You must call this method for each question in a question set.
  • If the question has an answer_type value of TEXT_AND_FILES, then you must upload the documents using POST Create a document for a person or POST Create a document for a business.
  • Solaris will not review the answers to the questions in the question set until all of them have been marked as ready_for_review.

Path
question_idstringrequired

Solaris UID of question

question_set_idstringrequired

Solaris UID of question set

Bodyapplication/json

The content of the request.

responsestring

The answer text collected from the customer in your frontend.

Example: "Here is my answer to the question"
partner_notesstring

Optional notes that you may add to the answer for Solaris to take into consideration.

Example: "Optional notes"
attachmentsArray of strings

An array of Solaris document IDs related to documents provided by the customer for the answer. Only required if the question has an answer_type value of TEXT_AND_FILES.

Example: ["4c9464a1a29cbb5cf6090463ef7f49b9cdoc","876464a1a29cbb5cf6090463ef7f49a6cdoc"]
ready_for_reviewboolean

Indicates whether the answer is ready for review by Solaris. All questions in the question set must have a value of true for this property before Solaris will review them.

Default false
Example: true
application/json
{
  "response": "Here is my answer to the question",
  "partner_notes": "Optional notes",
  "attachments": [
    "4c9464a1a29cbb5cf6090463ef7f49b9cdoc",
    "876464a1a29cbb5cf6090463ef7f49a6cdoc"
  ],
  "ready_for_review": true
}

Responses

The operation was successful.

Bodyapplication/json
idstring

ID of the question.

Example: "1f0130f81d84ed3c75b32c428d5d7d93cqst"
deadlinestring(date-time)

UTC timestamp indicating the deadline for answering the question.

Example: "2022-09-15T11:20:16.840208Z"
questionstring

The question.

Example: "Provide your annual KYC report."
answer_typestring

The type of answer required from the recipient.

Enum"TEXT_ONLY""TEXT_AND_FILES"
Example: "TEXT_AND_FILES"
allowed_document_typesArray of strings

Indicates the allowed document types that the recipient may provide (if the question has an answer_type value of TEXT_AND_FILES).

Items Enum"ANNUAL_FINANCIAL_STATEMENT""KYC_REPORT""ID_DOCUMENT""SIGNATURE""PICTURE""QES_DOCUMENT""SIGNED_CONTRACT""SIGNED_QES_DOCUMENT""REGISTER_CHECK""REGISTER_EXTRACT"
Example: ["KYC_REPORT"]
created_atstring(date-time)

UTC timestamp from when the question was created.

Example: "2022-09-15T11:20:16.920885Z"
updated_atstring(date-time)

UTC timestamp from when the question was last updated.

Example: "2022-09-15T11:20:16.920914Z"
answerobject

Object containing data related to the recipient's answer.

Example: {"response":"Here is my annual KYC report","partner_notes":"Optional partner notes","attachments":["4c9464a1a29cbb5cf6090463ef7f49b9cdoc"],"ready_for_review":true}
Response
application/json
{
  "id": "1f0130f81d84ed3c75b32c428d5d7d93cqst",
  "question": "Provide your annual KYC report.",
  "answer_type": "TEXT_AND_FILES",
  "deadline": "2022-09-15T11:20:16.840208Z",
  "allowed_document_types": [
    "KYC_REPORT"
  ],
  "created_at": "2022-09-15T11:20:16.920885Z",
  "updated_at": "2022-09-15T11:20:16.920914Z",
  "answer": {
    "response": "Here is my annual KYC report",
    "partner_notes": "Optional partner notes",
    "attachments": [ … ],
    "ready_for_review": true
  }
}

List questions in a question set

Request

Returns an array containing all of the questions in a question set (specified in the request URL by its ID).

Path
question_set_idstringrequired

Solaris UID of question set

No request payload

Responses

The operation was successful.

Bodyapplication/json
idstring

ID of the question set.

Example: "b4897de4ad4142faa0a7822b84edf597cqset"
entity_idstring

ID of the entity (person or business) to whom the question set is assigned.

Example: "1fa130f81d84ed3c75b32c428d5d7d93cper"
context_idstring

The ID of an additional Solaris resource related to the question set (e.g., an identification).

Example: "1fa130f81d84ed3c75b32c428d5d7d93ccnt"
deadlinestring(date-time)

The deadline for answering all questions in the set.

Example: "2023-12-07T00:00:00Z"
recipientobject

Object containing information about the question set recipient.

Example: {"recipient_id":"1fa130f81d84ed3c75b32c428d5d7d93cper","recipient_type":"CUSTOMER"}
questionsArray of objects(Solaris-Server-Decorators-Question)

Array containing all the questions in the question set.

Example: [{"id":"1f0130f81d84ed3c75b32c428d5d7d93cqst","question":"Provide your current address.","answer_type":"TEXT_AND_FILES","deadline":"2022-09-15T11:20:16.840208Z","allowed_document_types":["KYC_REPORT"]}]
Response
application/json
{
  "id": "b4897de4ad4142faa0a7822b84edf597cqset",
  "entity_id": "1fa130f81d84ed3c75b32c428d5d7d93cper",
  "context_id": "1fa130f81d84ed3c75b32c428d5d7d93ccnt",
  "description": "some description",
  "deadline": "2023-12-07T00:00:00Z",
  "recipient": {
    "recipient_id": "1fa130f81d84ed3c75b32c428d5d7d93cper",
    "recipient_type": "CUSTOMER"
  },
  "questions": [
    { … }
  ]
}

Terms and Conditions events

Operations