API status

All user related paths.

get

Get all users

Returns the list of all users.

sortstring

Sort the result by created_at, updated_at.

Default
"created_at"
Enum
  • created_at
  • updated_at
orderstring

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default
"ASC"
Enum
  • ASC
  • DESC
offsetint

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Format
int32
Min
0
limitint

Use the limit argument to specify the maximum number of items returned.

Format
int32
Default
100
Min
0
Max
1000

Responses

Response examples

OK

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "created_at",
    "order": "ASC"
  },
  "data": [
    {
      "id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
      "created_at": "2021-07-21T14:10:00.00Z",
      "updated_at": "2021-07-21T14:10:00.00Z",
      "first_name": "Karl",
      "last_name": "Schmidt",
      "salutation": "SALUTATION_MALE",
      "title": "DR",
      "birth_date": "1972-09-30",
      "birth_city": "Berlin",
      "birth_country": "DE",
      "birth_name": "Schmidt",
      "nationalities": [
        "DE",
        "AU"
      ],
      "postal_address": {
        "address_line1": "Rosenweg 221",
        "address_line2": "apt. 33",
        "postcode": "45678",
        "city": "Berlin",
        "state": "BE",
        "country": "DE"
      },
      "address": {
        "address_line1": "Rosenweg 221",
        "address_line2": "apt. 33",
        "postcode": "45678",
        "city": "Berlin",
        "state": "BE",
        "country": "DE"
      },
      "status": "ACTIVE"
    },
    {
      "id": "287673ef-1bae-4d8a-9e78-8ddaae249d72",
      "created_at": "2021-07-21T14:10:00.00Z",
      "updated_at": "2021-07-21T14:10:00.00Z",
      "first_name": "John",
      "last_name": "Doe",
      "salutation": "SALUTATION_MALE",
      "title": "PROF_DR",
      "birth_date": "1970-10-01",
      "birth_city": "Berlin",
      "birth_country": "DE",
      "birth_name": "Schmidt",
      "nationalities": [
        "DE",
        "AU"
      ],
      "postal_address": null,
      "address": {
        "address_line1": "Rosenweg 221",
        "address_line2": "apt. 33",
        "postcode": "45678",
        "city": "Berlin",
        "state": "BE",
        "country": "DE"
      },
      "status": "ACTIVE"
    }
  ]
}
post

Create a user

Creates a user.

Must match one of

first_namestring

required

First name(s) of the user. Please include all first and middle names of the user.

Min Length
2
Max Length
100
last_namestring

required

Last name of the user.

Min Length
1
Max Length
100
salutationstring

Salutation of the user used in reports and statements.

  • (empty string) -
  • SALUTATION_MALE -
  • SALUTATION_FEMALE -
  • SALUTATION_FEMALE_MARRIED -
  • SALUTATION_DIVERSE -
Default
""
Enum
  • SALUTATION_MALE
  • SALUTATION_FEMALE
  • SALUTATION_FEMALE_MARRIED
  • SALUTATION_DIVERSE
titlestring

Title of the user used in reports and statements.

  • (empty string) -
  • DR - Doctor
  • PROF - Professor
  • PROF_DR -
  • DIPL_ING - Graduate engineer (Diplom-Ingenieur)
  • MAGISTER -
Default
""
Enum
  • DR
  • PROF
  • PROF_DR
  • DIPL_ING
  • MAGISTER
birth_datestring

required

Birth date of the user in YYYY-MM-DD format. RFC 3339, section 5.6

Format
date
birth_citystring
Min Length
1
Max Length
85
birth_countrystring

Accepted country code. ISO 3166-1 alpha-2 codes.

Enum
  • AD
  • AE
  • AF
  • AG
  • AI
  • AL
  • AM
  • AO
  • AQ
  • AR
  • AS
  • AT
  • AU
  • AW
  • AX
  • AZ
  • BA
  • BB
  • BD
  • BE
  • BF
  • BG
  • BH
  • BI
  • BJ
  • BL
  • BM
  • BN
  • BO
  • BQ
  • BR
  • BS
  • BT
  • BV
  • BW
  • BY
  • BZ
  • CA
  • CC
  • CD
  • CF
  • CG
  • CH
  • CI
  • CK
  • CL
  • CM
  • CN
  • CO
  • CR
  • CU
  • CV
  • CW
  • CX
  • CY
  • CZ
  • DE
  • DJ
  • DK
  • DM
  • DO
  • DZ
  • EC
  • EE
  • EG
  • EH
  • ER
  • ES
  • ET
  • FI
  • FJ
  • FK
  • FM
  • FO
  • FR
  • GA
  • GB
  • GD
  • GE
  • GF
  • GG
  • GH
  • GI
  • GL
  • GM
  • GN
  • GP
  • GQ
  • GR
  • GS
  • GT
  • GU
  • GW
  • GY
  • HK
  • HM
  • HN
  • HR
  • HT
  • HU
  • ID
  • IE
  • IL
  • IM
  • IN
  • IO
  • IQ
  • IR
  • IS
  • IT
  • JE
  • JM
  • JO
  • JP
  • KE
  • KG
  • KH
  • KI
  • KM
  • KN
  • KP
  • KR
  • KW
  • KY
  • KZ
  • LA
  • LB
  • LC
  • LI
  • LK
  • LR
  • LS
  • LT
  • LU
  • LV
  • LY
  • MA
  • MC
  • MD
  • ME
  • MF
  • MG
  • MH
  • MK
  • ML
  • MM
  • MN
  • MO
  • MP
  • MQ
  • MR
  • MS
  • MT
  • MU
  • MV
  • MW
  • MX
  • MY
  • MZ
  • NA
  • NC
  • NE
  • NF
  • NG
  • NI
  • NL
  • NO
  • NP
  • NR
  • NU
  • NZ
  • OM
  • PA
  • PE
  • PF
  • PG
  • PH
  • PK
  • PL
  • PM
  • PN
  • PR
  • PS
  • PT
  • PW
  • PY
  • QA
  • RE
  • RO
  • RS
  • RU
  • RW
  • SA
  • SB
  • SC
  • SD
  • SE
  • SG
  • SH
  • SI
  • SJ
  • SK
  • SL
  • SM
  • SN
  • SO
  • SR
  • SS
  • ST
  • SV
  • SX
  • SY
  • SZ
  • TC
  • TD
  • TF
  • TG
  • TH
  • TJ
  • TK
  • TL
  • TM
  • TN
  • TO
  • TR
  • TT
  • TV
  • TW
  • TZ
  • UA
  • UG
  • UM
  • US
  • UY
  • UZ
  • VA
  • VC
  • VE
  • VG
  • VI
  • VN
  • VU
  • WF
  • WS
  • XK
  • YE
  • YT
  • ZA
  • ZM
  • ZW
birth_namestring

If applicable, birth name of the user.

Max Length
100
nationalitiesarray

required

Nationalities of the user. ISO 3166 alpha-2 Codes.

Accepted country code. ISO 3166-1 alpha-2 codes.

Enum
  • AD
  • AE
  • AF
  • AG
  • AI
  • AL
  • AM
  • AO
  • AQ
  • AR
  • AS
  • AT
  • AU
  • AW
  • AX
  • AZ
  • BA
  • BB
  • BD
  • BE
  • BF
  • BG
  • BH
  • BI
  • BJ
  • BL
  • BM
  • BN
  • BO
  • BQ
  • BR
  • BS
  • BT
  • BV
  • BW
  • BY
  • BZ
  • CA
  • CC
  • CD
  • CF
  • CG
  • CH
  • CI
  • CK
  • CL
  • CM
  • CN
  • CO
  • CR
  • CU
  • CV
  • CW
  • CX
  • CY
  • CZ
  • DE
  • DJ
  • DK
  • DM
  • DO
  • DZ
  • EC
  • EE
  • EG
  • EH
  • ER
  • ES
  • ET
  • FI
  • FJ
  • FK
  • FM
  • FO
  • FR
  • GA
  • GB
  • GD
  • GE
  • GF
  • GG
  • GH
  • GI
  • GL
  • GM
  • GN
  • GP
  • GQ
  • GR
  • GS
  • GT
  • GU
  • GW
  • GY
  • HK
  • HM
  • HN
  • HR
  • HT
  • HU
  • ID
  • IE
  • IL
  • IM
  • IN
  • IO
  • IQ
  • IR
  • IS
  • IT
  • JE
  • JM
  • JO
  • JP
  • KE
  • KG
  • KH
  • KI
  • KM
  • KN
  • KP
  • KR
  • KW
  • KY
  • KZ
  • LA
  • LB
  • LC
  • LI
  • LK
  • LR
  • LS
  • LT
  • LU
  • LV
  • LY
  • MA
  • MC
  • MD
  • ME
  • MF
  • MG
  • MH
  • MK
  • ML
  • MM
  • MN
  • MO
  • MP
  • MQ
  • MR
  • MS
  • MT
  • MU
  • MV
  • MW
  • MX
  • MY
  • MZ
  • NA
  • NC
  • NE
  • NF
  • NG
  • NI
  • NL
  • NO
  • NP
  • NR
  • NU
  • NZ
  • OM
  • PA
  • PE
  • PF
  • PG
  • PH
  • PK
  • PL
  • PM
  • PN
  • PR
  • PS
  • PT
  • PW
  • PY
  • QA
  • RE
  • RO
  • RS
  • RU
  • RW
  • SA
  • SB
  • SC
  • SD
  • SE
  • SG
  • SH
  • SI
  • SJ
  • SK
  • SL
  • SM
  • SN
  • SO
  • SR
  • SS
  • ST
  • SV
  • SX
  • SY
  • SZ
  • TC
  • TD
  • TF
  • TG
  • TH
  • TJ
  • TK
  • TL
  • TM
  • TN
  • TO
  • TR
  • TT
  • TV
  • TW
  • TZ
  • UA
  • UG
  • UM
  • US
  • UY
  • UZ
  • VA
  • VC
  • VE
  • VG
  • VI
  • VN
  • VU
  • WF
  • WS
  • XK
  • YE
  • YT
  • ZA
  • ZM
  • ZW
addressobject (Address)

required

Address. Must not be a P.O. box or c/o address.

postal_addressOne Of

User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.

Must match one of

branch_idstring

Unique identifier of the market the user is onboarded on. Only relevant if the client is operating in different markets and the client is configured accordingly

Format
uuid

Responses

Request examples

{
  "first_name": "Karl",
  "last_name": "Schmidt",
  "salutation": "SALUTATION_MALE",
  "title": "DR",
  "birth_date": "1972-09-30",
  "birth_city": "Berlin",
  "birth_country": "DE",
  "birth_name": "Schmidt",
  "nationalities": [
    "DE",
    "AU"
  ],
  "postal_address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "postcode": "45678",
    "city": "Berlin",
    "state": "BE",
    "country": "DE"
  },
  "address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "postcode": "45678",
    "city": "Berlin",
    "state": "BE",
    "country": "DE"
  }
}

Response examples

User created.

{
  "id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "first_name": "Karl",
  "last_name": "Schmidt",
  "salutation": "SALUTATION_MALE",
  "title": "DR",
  "birth_date": "1972-09-30",
  "birth_city": "Berlin",
  "birth_country": "DE",
  "birth_name": "Schmidt",
  "nationalities": [
    "DE",
    "AU"
  ],
  "postal_address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "postcode": "45678",
    "city": "Berlin",
    "state": "BE",
    "country": "DE"
  },
  "address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "postcode": "45678",
    "city": "Berlin",
    "state": "BE",
    "country": "DE"
  },
  "status": "ACTIVE"
}
get

Get a user by ID

Returns the user specified by ID.

user_idstring

required

User unique identifier.

Format
uuid

Responses

Response examples

OK

{
  "id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "first_name": "Karl",
  "last_name": "Schmidt",
  "salutation": "SALUTATION_MALE",
  "title": "DR",
  "birth_date": "1972-09-30",
  "birth_city": "Berlin",
  "birth_country": "DE",
  "birth_name": "Schmidt",
  "nationalities": [
    "DE",
    "AU"
  ],
  "postal_address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "postcode": "45678",
    "city": "Berlin",
    "state": "BE",
    "country": "DE"
  },
  "address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "postcode": "45678",
    "city": "Berlin",
    "state": "BE",
    "country": "DE"
  },
  "status": "ACTIVE"
}
delete

Offboard a user

Starts the user offboarding process in the background.

user_idstring

required

User unique identifier.

Format
uuid

Responses

Response examples

The request has been successfully accepted and will be processed asynchronously.

Empty response

post

Change user data

Requests a data change for a user specified by ID.

Must match one of

first_namestring

First name of the user.

Min Length
2
Max Length
100
last_namestring

Last name of the user.

Min Length
2
Max Length
100
salutationstring

Salutation of the user used in reports and statements.

  • (empty string) -
  • SALUTATION_MALE -
  • SALUTATION_FEMALE -
  • SALUTATION_FEMALE_MARRIED -
  • SALUTATION_DIVERSE -
Default
""
Enum
  • SALUTATION_MALE
  • SALUTATION_FEMALE
  • SALUTATION_FEMALE_MARRIED
  • SALUTATION_DIVERSE
titlestring

Title of the user used in reports and statements.

  • (empty string) -
  • DR - Doctor
  • PROF - Professor
  • PROF_DR -
  • DIPL_ING - Graduate engineer (Diplom-Ingenieur)
  • MAGISTER -
Default
""
Enum
  • DR
  • PROF
  • PROF_DR
  • DIPL_ING
  • MAGISTER
birth_datestring

Birth date of the user in YYYY-MM-DD format. RFC 3339, section 5.6

Format
date
birth_citystring
Min Length
1
Max Length
85
birth_countrystring

Accepted country code. ISO 3166-1 alpha-2 codes.

Enum
  • AD
  • AE
  • AF
  • AG
  • AI
  • AL
  • AM
  • AO
  • AQ
  • AR
  • AS
  • AT
  • AU
  • AW
  • AX
  • AZ
  • BA
  • BB
  • BD
  • BE
  • BF
  • BG
  • BH
  • BI
  • BJ
  • BL
  • BM
  • BN
  • BO
  • BQ
  • BR
  • BS
  • BT
  • BV
  • BW
  • BY
  • BZ
  • CA
  • CC
  • CD
  • CF
  • CG
  • CH
  • CI
  • CK
  • CL
  • CM
  • CN
  • CO
  • CR
  • CU
  • CV
  • CW
  • CX
  • CY
  • CZ
  • DE
  • DJ
  • DK
  • DM
  • DO
  • DZ
  • EC
  • EE
  • EG
  • EH
  • ER
  • ES
  • ET
  • FI
  • FJ
  • FK
  • FM
  • FO
  • FR
  • GA
  • GB
  • GD
  • GE
  • GF
  • GG
  • GH
  • GI
  • GL
  • GM
  • GN
  • GP
  • GQ
  • GR
  • GS
  • GT
  • GU
  • GW
  • GY
  • HK
  • HM
  • HN
  • HR
  • HT
  • HU
  • ID
  • IE
  • IL
  • IM
  • IN
  • IO
  • IQ
  • IR
  • IS
  • IT
  • JE
  • JM
  • JO
  • JP
  • KE
  • KG
  • KH
  • KI
  • KM
  • KN
  • KP
  • KR
  • KW
  • KY
  • KZ
  • LA
  • LB
  • LC
  • LI
  • LK
  • LR
  • LS
  • LT
  • LU
  • LV
  • LY
  • MA
  • MC
  • MD
  • ME
  • MF
  • MG
  • MH
  • MK
  • ML
  • MM
  • MN
  • MO
  • MP
  • MQ
  • MR
  • MS
  • MT
  • MU
  • MV
  • MW
  • MX
  • MY
  • MZ
  • NA
  • NC
  • NE
  • NF
  • NG
  • NI
  • NL
  • NO
  • NP
  • NR
  • NU
  • NZ
  • OM
  • PA
  • PE
  • PF
  • PG
  • PH
  • PK
  • PL
  • PM
  • PN
  • PR
  • PS
  • PT
  • PW
  • PY
  • QA
  • RE
  • RO
  • RS
  • RU
  • RW
  • SA
  • SB
  • SC
  • SD
  • SE
  • SG
  • SH
  • SI
  • SJ
  • SK
  • SL
  • SM
  • SN
  • SO
  • SR
  • SS
  • ST
  • SV
  • SX
  • SY
  • SZ
  • TC
  • TD
  • TF
  • TG
  • TH
  • TJ
  • TK
  • TL
  • TM
  • TN
  • TO
  • TR
  • TT
  • TV
  • TW
  • TZ
  • UA
  • UG
  • UM
  • US
  • UY
  • UZ
  • VA
  • VC
  • VE
  • VG
  • VI
  • VN
  • VU
  • WF
  • WS
  • XK
  • YE
  • YT
  • ZA
  • ZM
  • ZW
birth_namestring

If applicable, birth name of the user.

Max Length
100
nationalitiesarray

Nationalities of the user. ISO 3166 alpha-2 Codes.

Accepted country code. ISO 3166-1 alpha-2 codes.

Enum
  • AD
  • AE
  • AF
  • AG
  • AI
  • AL
  • AM
  • AO
  • AQ
  • AR
  • AS
  • AT
  • AU
  • AW
  • AX
  • AZ
  • BA
  • BB
  • BD
  • BE
  • BF
  • BG
  • BH
  • BI
  • BJ
  • BL
  • BM
  • BN
  • BO
  • BQ
  • BR
  • BS
  • BT
  • BV
  • BW
  • BY
  • BZ
  • CA
  • CC
  • CD
  • CF
  • CG
  • CH
  • CI
  • CK
  • CL
  • CM
  • CN
  • CO
  • CR
  • CU
  • CV
  • CW
  • CX
  • CY
  • CZ
  • DE
  • DJ
  • DK
  • DM
  • DO
  • DZ
  • EC
  • EE
  • EG
  • EH
  • ER
  • ES
  • ET
  • FI
  • FJ
  • FK
  • FM
  • FO
  • FR
  • GA
  • GB
  • GD
  • GE
  • GF
  • GG
  • GH
  • GI
  • GL
  • GM
  • GN
  • GP
  • GQ
  • GR
  • GS
  • GT
  • GU
  • GW
  • GY
  • HK
  • HM
  • HN
  • HR
  • HT
  • HU
  • ID
  • IE
  • IL
  • IM
  • IN
  • IO
  • IQ
  • IR
  • IS
  • IT
  • JE
  • JM
  • JO
  • JP
  • KE
  • KG
  • KH
  • KI
  • KM
  • KN
  • KP
  • KR
  • KW
  • KY
  • KZ
  • LA
  • LB
  • LC
  • LI
  • LK
  • LR
  • LS
  • LT
  • LU
  • LV
  • LY
  • MA
  • MC
  • MD
  • ME
  • MF
  • MG
  • MH
  • MK
  • ML
  • MM
  • MN
  • MO
  • MP
  • MQ
  • MR
  • MS
  • MT
  • MU
  • MV
  • MW
  • MX
  • MY
  • MZ
  • NA
  • NC
  • NE
  • NF
  • NG
  • NI
  • NL
  • NO
  • NP
  • NR
  • NU
  • NZ
  • OM
  • PA
  • PE
  • PF
  • PG
  • PH
  • PK
  • PL
  • PM
  • PN
  • PR
  • PS
  • PT
  • PW
  • PY
  • QA
  • RE
  • RO
  • RS
  • RU
  • RW
  • SA
  • SB
  • SC
  • SD
  • SE
  • SG
  • SH
  • SI
  • SJ
  • SK
  • SL
  • SM
  • SN
  • SO
  • SR
  • SS
  • ST
  • SV
  • SX
  • SY
  • SZ
  • TC
  • TD
  • TF
  • TG
  • TH
  • TJ
  • TK
  • TL
  • TM
  • TN
  • TO
  • TR
  • TT
  • TV
  • TW
  • TZ
  • UA
  • UG
  • UM
  • US
  • UY
  • UZ
  • VA
  • VC
  • VE
  • VG
  • VI
  • VN
  • VU
  • WF
  • WS
  • XK
  • YE
  • YT
  • ZA
  • ZM
  • ZW
addressobject (Address)

Address. Must not be a P.O. box or c/o address.

postal_addressOne Of

User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.

Must match one of

branch_idstring

Unique identifier of the market the user is onboarded on. Only relevant if the client is operating in different markets and the client is configured accordingly

Format
uuid

Responses

Request examples

{
  "first_name": "Karl",
  "last_name": "Schmidt",
  "issuance_date": "2030-01-01",
  "data_download_link": "https://bucket.customer.com/ident/user3.zip",
  "document_type": "ID_CARD"
}

Response examples

The request has been successfully accepted and will be processed asynchronously.

Empty response

webhook

Users events

idstring

required

Event unique identifier

Format
uuid
created_atstring

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

Format
date-time
typestring

required

Event type

Enum
  • USER.CREATED
  • USER.ACTIVATED
  • USER.DEACTIVATED
  • USER.DATA_CHANGED
  • USER.DATA_CHANGE_FAILED
  • USER.OFFBOARDING_INITIATED
  • USER.OFFBOARDED
objectOne Of

required

Must match one of

Must match one of

webhook_idstring

required

Webhook unique identifier.

Format
uuid

Responses

Request examples

{
  "id": "2df83681-6a42-4837-a554-a8197335bcfa",
  "created_at": "2021-11-19T13:06:51.980159529Z",
  "type": "USER.CREATED",
  "object": {
    "created_at": "2021-11-22T09:04:42Z",
    "updated_at": "2021-11-22T09:04:42Z",
    "first_name": "Jane",
    "last_name": "Doe",
    "salutation": "SALUTATION_FEMALE",
    "title": "PROF",
    "birth_date": "1990-01-01",
    "birth_city": "Berlin",
    "birth_country": "DE",
    "birth_name": "Smith",
    "nationalities": [
      "DE",
      "CH"
    ],
    "address": {
      "address_line1": "Torstrasse",
      "address_line2": "12a",
      "city": "Berlin",
      "country": "DE",
      "postcode": "10115",
      "state": "BE"
    },
    "id": "a1752f00-93d5-4b77-a148-959cd315581b",
    "postal_address": {
      "address_line1": "Thorstrasse",
      "address_line2": "123",
      "city": "Berlin",
      "country": "DE",
      "postcode": "10115",
      "state": "BE"
    },
    "status": "ACTIVE",
    "branch_id": "e6373bfa-ff12-4004-8de9-747ac96764da"
  },
  "webhook_id": "1b097e06-8a14-4181-b72a-de0972a3c57b"
}

Response examples

Request has been processed successfully.

Empty response