Skip to content
/Authorized persons

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

Person language settings

Operations

Authorized persons

Operations

Add authorized person to person account

Request

Adds an existing person to a person account as an authorized person. Note: This call triggers the change request process.

Path
person_idstringrequired
account_idstringrequired
Bodyapplication/jsonrequired

The content of the request.

authorized_person_idstring

The ID of the person to add to the account as an authorized person.

Example: "0ba2211cab11af6094d60ead81f2bd9dcper"
skip_2faboolean

Skip change request, add authorized person without 2fa (Optional). Skipping change request works only if the partner settings are adjusted to allow the skip.

application/json
{
  "authorized_person_id": "0ba2211cab11af6094d60ead81f2bd9dcper",
  "skip_2fa": false
}

Responses

The change request was successfully confirmed, and the authorized person is now added to the account.

Bodyapplication/json
idstring

ID of the authorized person relationship.

Example: "c25ac6d8a4774e0dacb61a70427e0782"
authorized_person_idstring

Person ID of the authorized person.

Example: "0ba2211cab11af6094d60ead81f2bd9dcper"
valid_fromstring

The date from which the authorized person has been authorized on the account.

Example: "2021-04-01"
valid_untilstring

The date until which the authorized person is authorized on the account.

Example: "2031-04-01"
Response
application/json
{
  "id": "c25ac6d8a4774e0dacb61a70427e0782",
  "authorized_person_id": "0ba2211cab11af6094d60ead81f2bd9dcper",
  "valid_from": "2021-04-01",
  "valid_until": "2031-04-01"
}

Index authorized persons for a person account

Request

Returns an array containing all authorized persons for a person account.

Path
person_idstringrequired
account_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

ID of the authorized person relationship.

Example: "c25ac6d8a4774e0dacb61a70427e0782"
authorized_person_idstring

Person ID of the authorized person.

Example: "0ba2211cab11af6094d60ead81f2bd9dcper"
valid_fromstring

The date from which the authorized person has been authorized on the account.

Example: "2021-04-01"
valid_untilstring

The date until which the authorized person is authorized on the account.

Example: "2031-04-01"
]
Response
application/json
[
  {
    "id": "c25ac6d8a4774e0dacb61a70427e0782",
    "authorized_person_id": "0ba2211cab11af6094d60ead81f2bd9dcper",
    "valid_from": "2021-04-01",
    "valid_until": "2031-04-01"
  }
]

Retrieve an authorized person for a person account

Request

Returns information about an authorized person associated with a person account.

Path
person_idstringrequired
account_idstringrequired
idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

ID of the authorized person relationship.

Example: "c25ac6d8a4774e0dacb61a70427e0782"
authorized_person_idstring

Person ID of the authorized person.

Example: "0ba2211cab11af6094d60ead81f2bd9dcper"
valid_fromstring

The date from which the authorized person has been authorized on the account.

Example: "2021-04-01"
valid_untilstring

The date until which the authorized person is authorized on the account.

Example: "2031-04-01"
Response
application/json
{
  "id": "c25ac6d8a4774e0dacb61a70427e0782",
  "authorized_person_id": "0ba2211cab11af6094d60ead81f2bd9dcper",
  "valid_from": "2021-04-01",
  "valid_until": "2031-04-01"
}

Delete authorized person from a person account

Request

Removes an authorized person from a person account. Note that this request will not delete the person resource; it will simply remove the authorized person from the account. Note: This call triggers the change request process.

Path
person_idstringrequired
account_idstringrequired
idstringrequired
Bodyapplication/json

The content of the request.

skip_2faboolean

Skip change request, remove authorized person without 2fa (Optional). Skipping change request works only if the partner settings are adjusted to allow the skip.

application/json
{
  "skip_2fa": false
}

Responses

The request was accepted and now the customer must confirm the change request.

Bodyapplication/json
idstring

ID of the change request.

Example: "d6c778822b2d7bd3b778935bcfd0d1d3csc"
statusstring

The current status of the change request.

Enum"ACCEPTED""AUTHORIZATION_REQUIRED""CONFIRMATION_REQUIRED""COMPLETED""FAILED"
Example: "CONFIRMATION_REQUIRED"
updated_atstring(date-time)

UTC timestamp from the last time the change request was updated.

Example: "2022-04-21T13:59:52+00:00"
urlstring

URL to use to authorize the change request.

Example: "https://example.com/authorize"
Response
application/json
{
  "id": "d6c778822b2d7bd3b778935bcfd0d1d3csc",
  "status": "CONFIRMATION_REQUIRED",
  "updated_at": "2022-04-21T13:59:52+00:00",
  "url": "https://example.com/authorize"
}