Users & Accounts Management

User Identifiers

Download Spec

All user identifiers related paths.

get/users/{user_id}/identifiers

Get user identifiers

Lists all existing identifiers of a user used for transaction reporting.

user_idstring

required

User unique identifier.

Format: uuid

Responses

Response examples

{
  "data": [
    {
      "id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
      "created_at": "2021-07-21T14:10:00.00Z",
      "updated_at": "2021-07-21T14:10:00.00Z",
      "user_id": "00000ec2-d2ca-49ff-bbea-b92b5c3be203",
      "type": "NATIONAL_ID",
      "issuing_country": "PL",
      "identifier_standard": "PESEL",
      "identifier": "83053078917"
    },
    {
      "id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be111",
      "created_at": "2021-07-21T14:10:00.00Z",
      "updated_at": "2021-07-21T14:10:00.00Z",
      "user_id": "00000ec2-d2ca-49ff-bbea-b92b5c3be203",
      "type": "NATIONAL_ID",
      "issuing_country": "DK",
      "identifier_standard": "DPIC",
      "identifier": "3005837891"
    },
    {
      "id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be303",
      "created_at": "2021-07-21T14:10:00.00Z",
      "updated_at": "2021-07-21T14:10:00.00Z",
      "user_id": "00000ec2-d2ca-49ff-bbea-b92b5c3be505",
      "type": "NATIONAL_ID",
      "issuing_country": "DE",
      "identifier_standard": "CONCAT",
      "identifier": ""
    },
    {
      "id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be303",
      "created_at": "2021-07-21T14:10:00.00Z",
      "updated_at": "2021-07-21T14:10:00.00Z",
      "user_id": "00000ec2-d2ca-49ff-bbea-b92b5c3be505",
      "type": "PASSPORT",
      "issuing_country": "NL",
      "identifier_standard": "NLPN",
      "identifier": ""
    }
  ]
}

post/users/{user_id}/identifiers

Create a user identifier

Creates a new identifier for a user that will be used for transaction reporting obligations. This identifier is required for user activation if the user's nationalities do not allow reporting using the CONCAT format. More information can be found in the guides.

typestring

required

Identifier type.

NATIONAL_ID -
PASSPORT -

Default: "NATIONAL_ID"
Enum: NATIONAL_ID
PASSPORT

issuing_countrystring

required

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

identifierstring

required

Identifier value. See guide here

Min Length: 0
Max Length: 30

identifier_standardstring

Identifier standard abbreviation. If it's not provided, issuing country's corresponding 1st Priority Identifier Standard will be used by default. See guide here

Max Length: 6

Responses

Request examples

{
  "type": "NATIONAL_ID",
  "issuing_country": "PL",
  "identifier_standard": "PESEL",
  "identifier": "83053078917"
}

Response examples

The user identifier is created.

{
  "id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "user_id": "00000ec2-d2ca-49ff-bbea-b92b5c3be203",
  "type": "NATIONAL_ID",
  "issuing_country": "PL",
  "identifier_standard": "PESEL",
  "identifier": "83053078917"
}

get/users/{user_id}/identifiers/{identifier_id}

Get a user identifier by ID

Returns an existing identifier of a given user used for transaction reporting.

user_idstring

required

User unique identifier.

Format: uuid

identifier_idstring

required

Unique identifier for the user's national ID.

Format: uuid

Responses

Response examples

{
  "id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "user_id": "00000ec2-d2ca-49ff-bbea-b92b5c3be203",
  "type": "NATIONAL_ID",
  "issuing_country": "PL",
  "identifier_standard": "PESEL",
  "identifier": "83053078917"
}

patch/users/{user_id}/identifiers/{identifier_id}

Update a user identifier by ID

Updates an existing identifier of a given user used for transaction reporting.

identifierstring

required

Identifier value. See guide here

Min Length: 0
Max Length: 30

Responses

Request examples

{
  "identifier": "83053078111"
}

Response examples

The user identifier is updated.

{
  "id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-22T15:20:10.00Z",
  "user_id": "00000ec2-d2ca-49ff-bbea-b92b5c3be203",
  "type": "NATIONAL_ID",
  "issuing_country": "PL",
  "identifier_standard": "PESEL",
  "identifier": "83053078111"
}

Was this page helpful?