Users
Download SpecAll user related paths.
Authentication
oauth-client-credentials
Required Scopes:
users:read
users:admin
Responses
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/json
meta
object (meta)
required
data
One Of
required
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Examples
{
"data": [
{
"address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"city": "Berlin",
"country": "DE",
"postcode": "45678",
"state": "BE"
},
"birth_city": "Berlin",
"birth_country": "DE",
"birth_date": "1972-09-30",
"birth_name": "Schmidt",
"created_at": "2021-07-21T14:10:00.00Z",
"first_name": "Karl",
"id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
"last_name": "Schmidt",
"nationalities": [
"DE",
"AU"
],
"postal_address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"city": "Berlin",
"country": "DE",
"postcode": "45678",
"state": "BE"
},
"salutation": "SALUTATION_MALE",
"status": "ACTIVE",
"title": "DR",
"updated_at": "2021-07-21T14:10:00.00Z"
},
{
"address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"city": "Berlin",
"country": "DE",
"postcode": "45678",
"state": "BE"
},
"birth_city": "Berlin",
"birth_country": "DE",
"birth_date": "1970-10-01",
"birth_name": "Schmidt",
"created_at": "2021-07-21T14:10:00.00Z",
"first_name": "John",
"id": "287673ef-1bae-4d8a-9e78-8ddaae249d72",
"last_name": "Doe",
"nationalities": [
"DE",
"AU"
],
"postal_address": null,
"salutation": "SALUTATION_MALE",
"status": "ACTIVE",
"title": "PROF_DR",
"updated_at": "2021-07-21T14:10:00.00Z"
}
],
"meta": {
"count": 1,
"limit": 100,
"offset": 0,
"order": "ASC",
"sort": "id",
"total_count": 1
}
}
{
"data": [
{
"address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"city": "Berlin",
"country": "DE",
"postcode": "45678",
"state": "BE"
},
"birth_city": "Berlin",
"birth_country": "DE",
"birth_date": "1972-09-30",
"birth_name": "Schmidt",
"created_at": "2021-07-21T14:10:00.00Z",
"data_privacy_and_sharing_agreement": {
"confirmed_at": "2020-08-24T14:16:22Z",
"consent_document_id": "fb1827c3-2b29-47e1-84da-996d09517edc"
},
"email": "karl.schmidt@example.com",
"fatca": {
"confirmed_at": "2020-08-24T14:15:22Z",
"status": false
},
"first_name": "Karl",
"id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
"last_name": "Schmidt",
"nationalities": [
"DE",
"AU"
],
"phone_number": "4930901820",
"postal_address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"city": "Berlin",
"country": "DE",
"postcode": "45678",
"state": "BE"
},
"salutation": "SALUTATION_MALE",
"status": "ACTIVE",
"terms_and_conditions": {
"confirmed_at": "2020-08-24T14:14:22Z",
"consent_document_id": "a8a87268-4f3c-4de2-abb9-a553a3bb7608"
},
"title": "DR",
"updated_at": "2021-07-21T14:10:00.00Z"
},
{
"address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"city": "Berlin",
"country": "DE",
"postcode": "45678",
"state": "BE"
},
"birth_city": "Berlin",
"birth_country": "DE",
"birth_date": "1972-09-30",
"birth_name": "Schmidt",
"created_at": "2021-07-21T14:10:00.00Z",
"data_privacy_and_sharing_agreement": {
"confirmed_at": "2020-08-24T14:16:22Z",
"consent_document_id": "fb1827c3-2b29-47e1-84da-996d09517edc"
},
"email": "karl.schmidt@example.com",
"fatca": {
"confirmed_at": "2020-08-24T14:15:22Z",
"status": false
},
"first_name": "Karl",
"id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
"last_name": "Schmidt",
"nationalities": [
"DE",
"AU"
],
"phone_number": "4930901820",
"postal_address": null,
"salutation": "SALUTATION_MALE",
"status": "ACTIVE",
"terms_and_conditions": {
"confirmed_at": "2020-08-24T14:14:22Z",
"consent_document_id": "a8a87268-4f3c-4de2-abb9-a553a3bb7608"
},
"title": "DR",
"updated_at": "2021-07-21T14:10:00.00Z"
}
],
"meta": {
"count": 1,
"limit": 100,
"offset": 0,
"order": "ASC",
"sort": "id",
"total_count": 1
}
}
{
"data": [],
"meta": {
"count": 0,
"limit": 100,
"offset": 0,
"order": "ASC",
"sort": "id",
"total_count": 0
}
}
{
"status": 400,
"type": "bad_request"
}
{
"status": 401,
"type": "unauthorized"
}
{
"status": 403,
"type": "forbidden"
}
{
"status": 406,
"type": "not_acceptable"
}
{
"status": 429,
"type": "too_many_requests"
}
{
"status": 500,
"type": "internal_server_error"
}
{
"status": 503,
"type": "method_not_allowed"
}
Authentication
oauth-client-credentials
Required Scopes:
users:admin
Responses
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/json
User - Create - Request
Any Of
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Request Examples
{
"address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"city": "Berlin",
"country": "DE",
"postcode": "45678",
"state": "BE"
},
"birth_city": "Berlin",
"birth_country": "DE",
"birth_date": "1972-09-30",
"birth_name": "Schmidt",
"first_name": "Karl",
"last_name": "Schmidt",
"nationalities": [
"DE",
"AU"
],
"postal_address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"city": "Berlin",
"country": "DE",
"postcode": "45678",
"state": "BE"
},
"salutation": "SALUTATION_MALE",
"title": "DR"
}
{
"address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"city": "Berlin",
"country": "DE",
"postcode": "45678",
"state": "BE"
},
"birth_city": "Berlin",
"birth_country": "DE",
"birth_date": "1972-09-30",
"birth_name": "Schmidt",
"data_privacy_and_sharing_agreement": {
"confirmed_at": "2020-08-24T14:16:22Z",
"consent_document_id": "fb1827c3-2b29-47e1-84da-996d09517edc"
},
"email": "karl.schmidt@example.com",
"fatca": {
"confirmed_at": "2020-08-24T14:15:22Z",
"status": false
},
"first_name": "Karl",
"last_name": "Schmidt",
"nationalities": [
"DE",
"AU"
],
"phone_number": "4930901820",
"postal_address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"city": "Berlin",
"country": "DE",
"postcode": "45678",
"state": "BE"
},
"salutation": "SALUTATION_MALE",
"terms_and_conditions": {
"confirmed_at": "2020-08-24T14:14:22Z",
"consent_document_id": "a8a87268-4f3c-4de2-abb9-a553a3bb7608"
},
"title": "DR"
}
Response Examples
{
"address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"city": "Berlin",
"country": "DE",
"postcode": "45678",
"state": "BE"
},
"birth_city": "Berlin",
"birth_country": "DE",
"birth_date": "1972-09-30",
"birth_name": "Schmidt",
"created_at": "2021-07-21T14:10:00.00Z",
"first_name": "Karl",
"id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
"last_name": "Schmidt",
"nationalities": [
"DE",
"AU"
],
"postal_address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"city": "Berlin",
"country": "DE",
"postcode": "45678",
"state": "BE"
},
"salutation": "SALUTATION_MALE",
"status": "ACTIVE",
"title": "DR",
"updated_at": "2021-07-21T14:10:00.00Z"
}
{
"address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"city": "Berlin",
"country": "DE",
"postcode": "45678",
"state": "BE"
},
"birth_city": "Berlin",
"birth_country": "DE",
"birth_date": "1972-09-30",
"birth_name": "Schmidt",
"created_at": "2021-07-21T14:10:00.00Z",
"data_privacy_and_sharing_agreement": {
"confirmed_at": "2020-08-24T14:16:22Z",
"consent_document_id": "fb1827c3-2b29-47e1-84da-996d09517edc"
},
"email": "karl.schmidt@example.com",
"fatca": {
"confirmed_at": "2020-08-24T14:15:22Z",
"status": false
},
"first_name": "Karl",
"id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
"last_name": "Schmidt",
"nationalities": [
"DE",
"AU"
],
"phone_number": "4930901820",
"postal_address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"city": "Berlin",
"country": "DE",
"postcode": "45678",
"state": "BE"
},
"salutation": "SALUTATION_MALE",
"status": "ACTIVE",
"terms_and_conditions": {
"confirmed_at": "2020-08-24T14:14:22Z",
"consent_document_id": "a8a87268-4f3c-4de2-abb9-a553a3bb7608"
},
"title": "DR",
"updated_at": "2021-07-21T14:10:00.00Z"
}
{
"status": 400,
"type": "bad_request"
}
{
"status": 401,
"type": "unauthorized"
}
{
"status": 403,
"type": "forbidden"
}
{
"status": 406,
"type": "not_acceptable"
}
{
"status": 429,
"type": "too_many_requests"
}
{
"status": 500,
"type": "internal_server_error"
}
{
"status": 503,
"type": "method_not_allowed"
}
Authentication
oauth-client-credentials
Required Scopes:
users:read
users:admin
Responses
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/json
User - Get - Response
Any Of
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Examples
{
"address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"city": "Berlin",
"country": "DE",
"postcode": "45678",
"state": "BE"
},
"birth_city": "Berlin",
"birth_country": "DE",
"birth_date": "1972-09-30",
"birth_name": "Schmidt",
"created_at": "2021-07-21T14:10:00.00Z",
"first_name": "Karl",
"id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
"last_name": "Schmidt",
"nationalities": [
"DE",
"AU"
],
"postal_address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"city": "Berlin",
"country": "DE",
"postcode": "45678",
"state": "BE"
},
"salutation": "SALUTATION_MALE",
"status": "ACTIVE",
"title": "DR",
"updated_at": "2021-07-21T14:10:00.00Z"
}
{
"address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"city": "Berlin",
"country": "DE",
"postcode": "45678",
"state": "BE"
},
"birth_city": "Berlin",
"birth_country": "DE",
"birth_date": "1972-09-30",
"birth_name": "Schmidt",
"created_at": "2021-07-21T14:10:00.00Z",
"data_privacy_and_sharing_agreement": {
"confirmed_at": "2020-08-24T14:16:22Z",
"consent_document_id": "fb1827c3-2b29-47e1-84da-996d09517edc"
},
"email": "karl.schmidt@example.com",
"fatca": {
"confirmed_at": "2020-08-24T14:15:22Z",
"status": false
},
"first_name": "Karl",
"id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
"last_name": "Schmidt",
"nationalities": [
"DE",
"AU"
],
"phone_number": "4930901820",
"postal_address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"city": "Berlin",
"country": "DE",
"postcode": "45678",
"state": "BE"
},
"salutation": "SALUTATION_MALE",
"status": "ACTIVE",
"terms_and_conditions": {
"confirmed_at": "2020-08-24T14:14:22Z",
"consent_document_id": "a8a87268-4f3c-4de2-abb9-a553a3bb7608"
},
"title": "DR",
"updated_at": "2021-07-21T14:10:00.00Z"
}
{
"status": 401,
"type": "unauthorized"
}
{
"status": 403,
"type": "forbidden"
}
{
"status": 404,
"type": "not_found"
}
{
"status": 406,
"type": "not_acceptable"
}
{
"status": 429,
"type": "too_many_requests"
}
{
"status": 500,
"type": "internal_server_error"
}
{
"status": 503,
"type": "method_not_allowed"
}
Authentication
oauth-client-credentials
Required Scopes:
users:admin
Responses
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Examples
{
"status": 401,
"type": "unauthorized"
}
{
"status": 403,
"type": "forbidden"
}
{
"status": 404,
"type": "not_found"
}
{
"status": 406,
"type": "not_acceptable"
}
{
"status": 429,
"type": "too_many_requests"
}
{
"status": 500,
"type": "internal_server_error"
}
{
"status": 503,
"type": "method_not_allowed"
}
Change user data
Requests a data change for a user specified by ID.
Authentication
oauth-client-credentials
Required Scopes:
users:admin
Responses
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Request Examples
{
"data_download_link": "https://bucket.customer.com/ident/user3.zip",
"document_type": "ID_CARD",
"first_name": "Karl",
"issuance_date": "2030-01-01",
"last_name": "Schmidt"
}
{
"email": "max@example.com"
}
{
"data_download_link": "https://bucket.customer.com/ident/user3.zip",
"document_type": "ID_CARD",
"issuance_date": "2030-01-01",
"nationalities": [
"DE"
]
}
{
"address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"city": "Berlin",
"country": "DE",
"postcode": "45678",
"state": "BE"
},
"data_download_link": "https://bucket.customer.com/por/user3.zip",
"document_type": "UTILITY_BILL",
"issuance_date": "2020-01-01"
}
{
"address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"city": "Berlin",
"country": "DE",
"postcode": "45678",
"state": "BE"
},
"birth_city": "Berlin",
"birth_country": "DE",
"birth_date": "1972-01-30",
"birth_name": "Schmidt",
"first_name": "Karl",
"last_name": "Schmidt",
"nationalities": [
"DE",
"AU"
],
"postal_address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"city": "Berlin",
"country": "DE",
"postcode": "45678",
"state": "BE"
},
"salutation": "SALUTATION_MALE",
"title": "PROF_DR"
}
Response Examples
{
"status": 400,
"type": "bad_request"
}
{
"status": 401,
"type": "unauthorized"
}
{
"status": 403,
"type": "forbidden"
}
{
"status": 404,
"type": "not_found"
}
{
"status": 406,
"type": "not_acceptable"
}
{
"status": 429,
"type": "too_many_requests"
}
{
"status": 500,
"type": "internal_server_error"
}
{
"status": 503,
"type": "method_not_allowed"
}
Get user account groups
Lists the account groups of a user specified by ID.
Authentication
oauth-client-credentials
Required Scopes:
accounts:read
accounts:admin
Responses
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/json
meta
object (meta)
required
data
array[object (Account Group)]
required
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Examples
{
"data": [
{
"created_at": "2020-08-24T14:15:22Z",
"id": "9d95820d-4333-46b6-98de-04ab7512e76f",
"securities_account_number": "123456789",
"status": "ACTIVE",
"type": "PERSONAL",
"updated_at": "2020-08-24T14:15:22Z",
"users": [
{
"id": "9c36af78-91a0-4174-a515-fc81214e3dab",
"type": "OWNER"
}
]
}
],
"meta": {
"count": 1,
"limit": 100,
"offset": 0,
"order": "ASC",
"sort": "id",
"total_count": 1
}
}
{
"status": 400,
"type": "bad_request"
}
{
"status": 401,
"type": "unauthorized"
}
{
"status": 403,
"type": "forbidden"
}
{
"status": 404,
"type": "not_found"
}
{
"status": 406,
"type": "not_acceptable"
}
{
"status": 429,
"type": "too_many_requests"
}
{
"status": 500,
"type": "internal_server_error"
}
{
"status": 503,
"type": "method_not_allowed"
}
Authentication
oauth-client-credentials
Required Scopes:
accounts:read
accounts:admin
Responses
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/json
meta
object (meta)
required
data
array[object (Account)]
required
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Examples
{
"data": [
{
"account_group_id": "fa2414ed-8d62-46fd-85ed-565a340c81d6",
"account_number": 1,
"created_at": "2020-08-24T14:15:22Z",
"id": "ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd",
"name": "Main account",
"status": "ACTIVE",
"type": "TRADING",
"updated_at": "2020-08-24T14:15:22Z",
"users": [
{
"id": "9c36af78-91a0-4174-a515-fc81214e3dab",
"type": "OWNER"
}
]
}
],
"meta": {
"count": 1,
"limit": 100,
"offset": 0,
"order": "ASC",
"sort": "id",
"total_count": 1
}
}
{
"status": 400,
"type": "bad_request"
}
{
"status": 401,
"type": "unauthorized"
}
{
"status": 403,
"type": "forbidden"
}
{
"status": 404,
"type": "not_found"
}
{
"status": 406,
"type": "not_acceptable"
}
{
"status": 429,
"type": "too_many_requests"
}
{
"status": 500,
"type": "internal_server_error"
}
{
"status": 503,
"type": "method_not_allowed"
}
Responses
Request Examples
{
"created_at": "2021-11-19T13:06:51.980159529Z",
"id": "2df83681-6a42-4837-a554-a8197335bcfa",
"object": {
"address": {
"address_line1": "Torstrasse",
"address_line2": "12a",
"city": "Berlin",
"country": "DE",
"postcode": "10115",
"state": "BE"
},
"birth_city": "Berlin",
"birth_country": "DE",
"birth_date": "1990-01-01",
"birth_name": "Smith",
"created_at": "2021-11-22T09:04:42Z",
"first_name": "Jane",
"id": "a1752f00-93d5-4b77-a148-959cd315581b",
"last_name": "Doe",
"nationalities": [
"DE",
"CH"
],
"postal_address": {
"address_line1": "Thorstrasse",
"address_line2": "123",
"city": "Berlin",
"country": "DE",
"postcode": "10115",
"state": "BE"
},
"salutation": "SALUTATION_FEMALE",
"status": "ACTIVE",
"title": "PROF",
"updated_at": "2021-11-22T09:04:42Z"
},
"type": "USER.CREATED",
"webhook_id": "1b097e06-8a14-4181-b72a-de0972a3c57b"
}
{
"created_at": "2021-11-22T09:04:42Z",
"id": "2df83681-6a42-4837-a554-a8197335bcfa",
"object": {
"address": {
"address_line1": "Torstrasse",
"address_line2": "12a",
"city": "Berlin",
"country": "DE",
"postcode": "10115",
"state": "BE"
},
"birth_city": "Berlin",
"birth_country": "DE",
"birth_date": "1990-01-01",
"birth_name": "Smith",
"created_at": "2021-11-22T09:04:42Z",
"data_privacy_and_sharing_agreement": {
"confirmed_at": "2021-02-03T17:14:46Z",
"consent_document_id": "dd42b6a9-d04d-4dd2-8c3b-36386eaa843a"
},
"email": "janedoe@example.com",
"fatca": {
"confirmed_at": "2020-02-03T17:14:46Z",
"status": false
},
"first_name": "Jane",
"id": "a1752f00-93d5-4b77-a148-959cd315581b",
"last_name": "Doe",
"nationalities": [
"DE",
"CH"
],
"phone_number": "0123456789",
"postal_address": {
"address_line1": "Thorstrasse",
"address_line2": "123",
"city": "Berlin",
"country": "DE",
"postcode": "10115",
"state": "BE"
},
"salutation": "SALUTATION_FEMALE",
"status": "ACTIVE",
"terms_and_conditions": {
"confirmed_at": "2020-02-03T17:14:46Z",
"consent_document_id": "62814307-f14b-40af-bc66-5942a549a759"
},
"title": "PROF",
"updated_at": "2021-11-22T09:04:42Z"
},
"type": "USER.CREATED",
"webhook_id": "1b097e06-8a14-4181-b72a-de0972a3c57b"
}
Was this page helpful?