improved
Release Notes: 20/11/2023
6 months ago
This release includes API changes to the Client and User APIs. Below, you'll find details about the modifications that have been included in this release.
Client API changes:
- An automatic user creation workflow for individual clients has been introduced.
The createUser option has been added to to the Create Client API.
This feature allows the creation of user and user-client relations at the moment of individual client creation.
Please note that this feature is only available for individual clients.
POST /clients
{
"workflow": {
"code": "direct",
"createUser": true
},
"data": {
"client": {
"identity": {
"type": "individual",
"givenName": "Canay",
"familyName": "Özel",
"birthDate": "1987-01-01",
"country": "TR",
"identifications": [
{
"type": "identity-card",
"identificationNumber": "12345678",
"issuingCountry": "TR",
"issueDate": "2022-01-01",
"expirationDate": "2023-01-01"
}
]
},
"profile": {
"identityType": "individual",
"residentialAddress": {
"country": "GB",
"region": "England",
"city": "London",
"street": "Baker Street",
"houseNumber": "221B",
"postalCode": "XYZ ABC",
"refinement": ""
},
"phone": "+441234567890",
"email": "[email protected]"
}
}
},
"connect": {},
"metadata": {}
}
POST /clients
{
"workflow": {
"code": "direct",
"createUser": true
},
"data": {
"client": {
"id": "00000000-0000-0000-0000-000000000000",
"clientNumber": "20663251",
"status": "active",
"identity": {
"type": "individual",
"givenName": "Canay",
"familyName": "Özel",
"birthDate": "1987-01-01",
"country": "TR",
"identifications": [
{
"type": "identity-card",
"identificationNumber": "12345678",
"issuingCountry": "TR",
"issueDate": "2022-01-01",
"expirationDate": "2023-01-01"
}
]
},
"profile": {
"identityType": "individual",
"residentialAddress": {
"country": "GB",
"region": "England",
"city": "London",
"street": "Baker Street",
"houseNumber": "221B",
"postalCode": "XYZ ABC",
"refinement": ""
},
"phone": "+441234567890",
"email": "[email protected]"
},
"fullName": "Canay Özel"
},
"user": {
"id": "00000000-0000-0000-0000-000000000000",
"email": "[email protected]",
"identity": {
"type": "individual",
"givenName": "Canay",
"familyName": "Özel",
"birthDate": "1987-01-01",
"country": "TR",
"identifications": [
{
"type": "identity-card",
"identificationNumber": "12345678",
"issuingCountry": "TR",
"issueDate": "2022-01-01",
"expirationDate": "2023-01-01"
}
]
},
"category": "external",
"type": "human"
},
"userClientRelation": {
"id": "00000000-0000-0000-0000-000000000000",
"userId": "00000000-0000-0000-0000-000000000000",
"clientId": "00000000-0000-0000-0000-000000000000",
"status": "allowed"
}
},
"connect": {},
"metadata": {}
}
User API changes:
- Direct creation of external human users has been introduced. API Guides
POST /users
{
"workflow": {
"code": "human.external.direct"
},
"data": {
"user": {
"email": "[email protected]",
"identity": {
"type": "individual",
"givenName": "bruce",
"familyName": "wayne",
"birthDate": "1987-01-01"
},
"profile": {
"phone": "+441234567890",
"residentialAddress": {
"country": "GB",
"region": "England",
"city": "London",
"street": "Baker Street",
"houseNumber": "221B",
"postalCode": "XYZ ABC",
"refinement": ""
}
}
},
"userClientRelations": [
{
"clientId": "00000000-0000-0000-0000-000000000000"
}
]
},
"connect": {},
"metadata": {}
}
POST /users
{
"workflow": {
"code": "human.external.direct"
},
"data": {
"user": {
"id": "00000000-0000-0000-0000-000000000000",
"email": "[email protected]",
"identity": {
"type": "individual",
"givenName": "bruce",
"familyName": "wayne",
"birthDate": "1987-01-01"
},
"profile": {
"phone": "+441234567890",
"residentialAddress": {
"country": "GB",
"region": "England",
"city": "London",
"street": "Baker Street",
"houseNumber": "221B",
"postalCode": "XYZ ABC",
"refinement": ""
}
},
"category": "external",
"type": "human",
"status": "active"
},
"userClientRelations": [
{
"id": "00000000-0000-0000-0000-000000000000",
"userId": "00000000-0000-0000-0000-000000000000",
"clientId": "00000000-0000-0000-0000-000000000000",
"status": "allowed"
}
]
},
"connect": {},
"metadata": {}
}