Skip to content
/Person documents

Persons (1.0)

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

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

Persons

Operations

Person mobile numbers

Operations

Person tax identifications

Operations

Person documents

Operations

Create a document for a person

Request

Uploads a document and links it to the person specified in the request URL.
Unlike most other endpoints, this request uses the content-type of multipart/form-data. You must submit the parameters as form-data items instead of a raw JSON body.
By default, uploaded documents are not accessible to customers (i.e., the customer_accessible value is set to false).

Path
person_idstringrequired
Bodymultipart/form-datarequired
document_typestring(Solaris-Enums-DocumentType)required

The type of document.

Enum"ACCOUNT_SNAPSHOT.FINTECSYSTEMS""ACCOUNT_STATEMENT""AML_POLICY""ANNUAL_FINANCIAL_STATEMENT""B2B_MANDATE""BALANCE_REPORT""BANK_REFERENCE""BUSINESS_ASSESSMENT""BUSINESS_FINANCIALS_XBRL""CREDIT_AGENCY_REPORT"
filestring(binary)required

The binary file to upload.

multipart/form-data
{
  "file": "string",
  "document_type": "ACCOUNT_SNAPSHOT.FINTECSYSTEMS"
}

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique identifier of the document.

Example: "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc"
namestring

The name of the file associated with the document.

Example: "Operation_authorization.png"
content_typestring

The content type of the file associated with the document.

Example: "image/png"
document_typestring
Enum"ACCOUNT_SNAPSHOT.FINTECSYSTEMS""ACCOUNT_STATEMENT""AML_POLICY""ANNUAL_FINANCIAL_STATEMENT""B2B_MANDATE""BALANCE_REPORT""BANK_REFERENCE""BUSINESS_ASSESSMENT""BUSINESS_FINANCIALS_XBRL""CREDIT_AGENCY_REPORT"
Example: "PICTURE"
sizeinteger

The file size, in bytes.

Example: 10187
customer_accessibleboolean

Indicates whether the customer has access to the document.

Example: false
created_atstring

UTC timestamp from when the document was created in Solaris' system.

Example: "2022-05-20T12:46:09Z"
deleted_atstring

UTC timestamp from when the document was deleted (if applicable).

Example: "null"
Response
application/json
{
  "id": "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc",
  "name": "Operation_authorization.png",
  "content_type": "image/png",
  "document_type": "PICTURE",
  "size": 10187,
  "customer_accessible": false,
  "created_at": "2022-05-20T12:46:09Z",
  "deleted_at": "null"
}

Index a person's documents

Request

Returns an array containing all documents linked to the person specified in the request URL.

Path
person_idstringrequired
Query
page[number]string

The number of results pages to return.

page[size]string

The size of each page in the response.

customer_accessibleboolean

Use this parameter to return only the documents that the customer may access.

include_deletedboolean

Use this parameter to include deleted documents in the results.

sortstring

Sorts the results by the date the document was created.

Value"created_at"
No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique identifier of the document.

Example: "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc"
namestring

The name of the file associated with the document.

Example: "Operation_authorization.png"
content_typestring

The content type of the file associated with the document.

Example: "image/png"
document_typestring
Enum"ACCOUNT_SNAPSHOT.FINTECSYSTEMS""ACCOUNT_STATEMENT""AML_POLICY""ANNUAL_FINANCIAL_STATEMENT""B2B_MANDATE""BALANCE_REPORT""BANK_REFERENCE""BUSINESS_ASSESSMENT""BUSINESS_FINANCIALS_XBRL""CREDIT_AGENCY_REPORT"
Example: "PICTURE"
sizeinteger

The file size, in bytes.

Example: 10187
customer_accessibleboolean

Indicates whether the customer has access to the document.

Example: false
created_atstring

UTC timestamp from when the document was created in Solaris' system.

Example: "2022-05-20T12:46:09Z"
deleted_atstring

UTC timestamp from when the document was deleted (if applicable).

Example: "null"
Response
application/json
{
  "id": "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc",
  "name": "Operation_authorization.png",
  "content_type": "image/png",
  "document_type": "PICTURE",
  "size": 10187,
  "customer_accessible": false,
  "created_at": "2022-05-20T12:46:09Z",
  "deleted_at": "null"
}

Download a document

Request

Returns the binary file related to the document specified in the request URL.

Path
person_idstringrequired
idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/json
datestring
Example: "Sun, 13 Aug 2017 20:35:45 GMT"
x-content-type-optionsstring
Example: "nosniff"
content-dispositionstring
Example: "attachment; filename=sample_pdf.pdf"
content-lengthstring
Example: "3028"
x-request-idstring
Example: "fbc2deff-8066-11e7-9271-02420a000109"
content-typestring
Example: "application/pdf"
Response
application/json
{
  "date": "Sun, 13 Aug 2017 20:35:45 GMT",
  "x-content-type-options": "nosniff",
  "content-disposition": "attachment; filename=sample_pdf.pdf",
  "content-length": "3028",
  "x-request-id": "fbc2deff-8066-11e7-9271-02420a000109",
  "content-type": "application/pdf"
}

Retrieve metadata about a document

Request

Returns metadata about a person's document, including the filename and type.

Path
person_idstringrequired
idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique identifier of the document.

Example: "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc"
namestring

The name of the file associated with the document.

Example: "Operation_authorization.png"
content_typestring

The content type of the file associated with the document.

Example: "image/png"
document_typestring
Enum"ACCOUNT_SNAPSHOT.FINTECSYSTEMS""ACCOUNT_STATEMENT""AML_POLICY""ANNUAL_FINANCIAL_STATEMENT""B2B_MANDATE""BALANCE_REPORT""BANK_REFERENCE""BUSINESS_ASSESSMENT""BUSINESS_FINANCIALS_XBRL""CREDIT_AGENCY_REPORT"
Example: "PICTURE"
sizeinteger

The file size, in bytes.

Example: 10187
customer_accessibleboolean

Indicates whether the customer has access to the document.

Example: false
created_atstring

UTC timestamp from when the document was created in Solaris' system.

Example: "2022-05-20T12:46:09Z"
deleted_atstring

UTC timestamp from when the document was deleted (if applicable).

Example: "null"
Response
application/json
{
  "id": "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc",
  "name": "Operation_authorization.png",
  "content_type": "image/png",
  "document_type": "PICTURE",
  "size": 10187,
  "customer_accessible": false,
  "created_at": "2022-05-20T12:46:09Z",
  "deleted_at": "null"
}

Update a person document's attributes

Request

Updates the document_type and/or customer_accessible attributes on a document.

Path
person_idstringrequired
idstringrequired
Bodyapplication/json

The content of the request.

document_typestring(Solaris-Enums-DocumentType)

The type of document.

Enum"ACCOUNT_SNAPSHOT.FINTECSYSTEMS""ACCOUNT_STATEMENT""AML_POLICY""ANNUAL_FINANCIAL_STATEMENT""B2B_MANDATE""BALANCE_REPORT""BANK_REFERENCE""BUSINESS_ASSESSMENT""BUSINESS_FINANCIALS_XBRL""CREDIT_AGENCY_REPORT"
customer_accessibleboolean

Flag that determine whether or not the customer may access the document.

Example: true
application/json
{
  "document_type": "ACCOUNT_SNAPSHOT.FINTECSYSTEMS",
  "customer_accessible": true
}

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique identifier of the document.

Example: "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc"
namestring

The name of the file associated with the document.

Example: "Operation_authorization.png"
content_typestring

The content type of the file associated with the document.

Example: "image/png"
document_typestring
Enum"ACCOUNT_SNAPSHOT.FINTECSYSTEMS""ACCOUNT_STATEMENT""AML_POLICY""ANNUAL_FINANCIAL_STATEMENT""B2B_MANDATE""BALANCE_REPORT""BANK_REFERENCE""BUSINESS_ASSESSMENT""BUSINESS_FINANCIALS_XBRL""CREDIT_AGENCY_REPORT"
Example: "PICTURE"
sizeinteger

The file size, in bytes.

Example: 10187
customer_accessibleboolean

Indicates whether the customer has access to the document.

Example: false
created_atstring

UTC timestamp from when the document was created in Solaris' system.

Example: "2022-05-20T12:46:09Z"
deleted_atstring

UTC timestamp from when the document was deleted (if applicable).

Example: "null"
Response
application/json
{
  "id": "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc",
  "name": "Operation_authorization.png",
  "content_type": "image/png",
  "document_type": "PICTURE",
  "size": 10187,
  "customer_accessible": false,
  "created_at": "2022-05-20T12:46:09Z",
  "deleted_at": "null"
}

Delete a document

Request

Marks a document as deleted.

Path
person_idstringrequired
idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique identifier of the document.

Example: "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc"
namestring

The name of the file associated with the document.

Example: "Operation_authorization.png"
content_typestring

The content type of the file associated with the document.

Example: "image/png"
document_typestring
Enum"ACCOUNT_SNAPSHOT.FINTECSYSTEMS""ACCOUNT_STATEMENT""AML_POLICY""ANNUAL_FINANCIAL_STATEMENT""B2B_MANDATE""BALANCE_REPORT""BANK_REFERENCE""BUSINESS_ASSESSMENT""BUSINESS_FINANCIALS_XBRL""CREDIT_AGENCY_REPORT"
Example: "PICTURE"
sizeinteger

The file size, in bytes.

Example: 10187
customer_accessibleboolean

Indicates whether the customer has access to the document.

Example: false
created_atstring

UTC timestamp from when the document was created in Solaris' system.

Example: "2022-05-20T12:46:09Z"
deleted_atstring

UTC timestamp from when the document was deleted (if applicable).

Example: "null"
Response
application/json
{
  "id": "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc",
  "name": "Operation_authorization.png",
  "content_type": "image/png",
  "document_type": "PICTURE",
  "size": 10187,
  "customer_accessible": false,
  "created_at": "2022-05-20T12:46:09Z",
  "deleted_at": "null"
}

Upload documents for a person identification

Request

Uploads an identification document for the person identification specified in the request URL. Note that this request uses the content-type of multipart/form-data and that the request body must be submitted as individual form-data items.

Path
person_idstringrequired
idstringrequired
Bodymultipart/form-datarequired
document_typestring(Solaris-Enums-DocumentType)required

The type of document.

Enum"ACCOUNT_SNAPSHOT.FINTECSYSTEMS""ACCOUNT_STATEMENT""AML_POLICY""ANNUAL_FINANCIAL_STATEMENT""B2B_MANDATE""BALANCE_REPORT""BANK_REFERENCE""BUSINESS_ASSESSMENT""BUSINESS_FINANCIALS_XBRL""CREDIT_AGENCY_REPORT"
filestring(binary)required

The binary file to upload.

multipart/form-data
{
  "file": "string",
  "document_type": "ACCOUNT_SNAPSHOT.FINTECSYSTEMS"
}

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique identifier of the document.

Example: "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc"
namestring

The name of the file associated with the document.

Example: "Operation_authorization.png"
content_typestring

The content type of the file associated with the document.

Example: "image/png"
document_typestring
Enum"ACCOUNT_SNAPSHOT.FINTECSYSTEMS""ACCOUNT_STATEMENT""AML_POLICY""ANNUAL_FINANCIAL_STATEMENT""B2B_MANDATE""BALANCE_REPORT""BANK_REFERENCE""BUSINESS_ASSESSMENT""BUSINESS_FINANCIALS_XBRL""CREDIT_AGENCY_REPORT"
Example: "PICTURE"
sizeinteger

The file size, in bytes.

Example: 10187
customer_accessibleboolean

Indicates whether the customer has access to the document.

Example: false
created_atstring

UTC timestamp from when the document was created in Solaris' system.

Example: "2022-05-20T12:46:09Z"
deleted_atstring

UTC timestamp from when the document was deleted (if applicable).

Example: "null"
Response
application/json
{
  "id": "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc",
  "name": "Operation_authorization.png",
  "content_type": "image/png",
  "document_type": "PICTURE",
  "size": 10187,
  "customer_accessible": false,
  "created_at": "2022-05-20T12:46:09Z",
  "deleted_at": "null"
}

Index documents for a person identification

Request

Returns all documents uploaded to the person identification specified in the request URL.

Path
person_idstringrequired
idstringrequired
Query
page[number]string

The number of results pages to return.

page[size]string

The size of each page in the response.

No request payload

Responses

Successful result of the operation

Bodyapplication/jsonArray [
idstring

Unique identifier of the document.

Example: "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc"
namestring

The name of the file associated with the document.

Example: "Operation_authorization.png"
content_typestring

The content type of the file associated with the document.

Example: "image/png"
document_typestring
Enum"ACCOUNT_SNAPSHOT.FINTECSYSTEMS""ACCOUNT_STATEMENT""AML_POLICY""ANNUAL_FINANCIAL_STATEMENT""B2B_MANDATE""BALANCE_REPORT""BANK_REFERENCE""BUSINESS_ASSESSMENT""BUSINESS_FINANCIALS_XBRL""CREDIT_AGENCY_REPORT"
Example: "PICTURE"
sizeinteger

The file size, in bytes.

Example: 10187
customer_accessibleboolean

Indicates whether the customer has access to the document.

Example: false
created_atstring

UTC timestamp from when the document was created in Solaris' system.

Example: "2022-05-20T12:46:09Z"
deleted_atstring

UTC timestamp from when the document was deleted (if applicable).

Example: "null"
]
Response
application/json
[
  {
    "id": "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc",
    "name": "Operation_authorization.png",
    "content_type": "image/png",
    "document_type": "PICTURE",
    "size": 10187,
    "customer_accessible": false,
    "created_at": "2022-05-20T12:46:09Z",
    "deleted_at": "null"
  }
]

(Sandbox only) Trigger account block or send notification due to outdated identity document

Request

Checks the expiration date of a person's identity document and then either triggers an account block (if the document has expired) or sends a notification that the document is about to expire. Only available on Sandbox for testing purposes.

Path
idstringrequired
No request payload

Responses

The customer's identity document is still valid, so no action was triggered.

Bodyapplication/json
document_validboolean

Indicates the validity of the customer's identity document.

Example: true
Response
application/json
{
  "document_valid": true
}

Person language settings

Operations

Authorized persons

Operations