removed
Release Notes: 07/09/2023
8 months ago
This release includes API changes to the Client, User and Beneficiary APIs. Below, you'll find details about the modifications that have been included in this release.
Client, User, and Beneficiary API changes:
- state, firstLine, and secondLine were removed from Client, User, and Beneficiary API address JSON objects. Clients & Users & Beneficiaries
Note: Deprecated fields have been removed from the address JSON objects in the Client, User, and Beneficiary APIs including residentialAddress, registrationAddress, tradingAddress and address fields.
POST /clients
{
"workflow": {
"code": "direct"
},
"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 /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 /beneficiaries
{
"workflow": {
"code": "direct"
},
"data": {
"beneficiary": {
"clientId": "3f0dceb7-9727-48c9-a2dc-5a13749d8993",
"identity": {
"type": "corporate",
"legalName": "Example Technologies Limited"
},
"contact": {
"phone": "+905551234567",
"email": "[email protected]",
"address": {
"country": "GB",
"region": "England",
"city": "London",
"street": "Baker Street",
"houseNumber": "221B",
"postalCode": "XYZ ABC",
"refinement": ""
}
},
"bankAccounts": [
{
"country": "GB",
"currency": "GBP",
"accountNumber": "12345678",
"iban": "GB12AB01234567890",
"routingCodes": {
"bic": "ABCDGBBK",
"sort-code": "123456"
}
}
]
}
},
"connect": {},
"metadata": {}
}