Release Notes for Client Attributes: 22/03/2025
23 days ago
This release includes adding an attributes field to the Client model. The attribute field is a key-value map that can store any additional metadata you'd like to link to the client. There are some reserved keys for each service provider.
Here are the client attributes details of creating a client Client Create API
POST /clients
{
"workflow": {
"code": "direct"
},
"data": {
"client": {
"identity": {
"type": "individual",
"givenName": "Railsr",
"familyName": "Rlb",
"birthDate": "1987-01-01",
"country": "GB",
"identifications": [
{
"type": "identity-card",
"identificationNumber": "12345677",
"issuingCountry": "GB",
"issueDate": "2022-01-01",
"expirationDate": "2032-01-01"
}
]
},
"profile": {
"identityType": "individual",
"residentialAddress": {
"country": "GB",
"region": "England",
"city": "London",
"street": "Baker Street",
"houseNumber": "221B",
"postalCode": "EC1Y 1AA",
"refinement": ""
},
"phone": "1012555123",
"email": "[email protected]"
},
"attributes": {
"accountUsage": "sendAndReceiveMoneyTransfers",
"riskScore": "low",
"isPep": "false",
"expectedVolumeRange": "5001-10000",
"expectedVolumeType": "monthly",
"expectedVolumeCurrency": "GBP"
}
}
},
"connect": {},
"metadata": {}
}
POST /clients
{
"workflow": {
"code": "direct"
},
"data": {
"client": {
"identity": {
"type": "corporate",
"legalName": "Foo Bar Inc.",
"tradingName": "",
"country": "GB",
"identifications": [
{
"type": "registration-number",
"identificationNumber": "12345678"
}
],
"incorporationDate": "2019-09-09",
"corporationType": "ltd"
},
"profile": {
"registrationAddress": {
"country": "GB",
"region": "Dewsbury Moor",
"city": "Dewsbury",
"street": "98 Low Rd",
"houseNumber": "15",
"postalCode": "WF13 3PS",
"refinement": ""
},
"identityType": "corporate",
"phone": "1012555123",
"email": "[email protected]"
},
"addresses": {
"tradingAddress": {
"country": "GB",
"region": "Dewsbury Moor",
"city": "Dewsbury",
"street": "92 Low Rd",
"houseNumber": "21",
"postalCode": "WF13 3PS",
"refinement": ""
}
},
"attributes": {
"accountUsage": "receiveClientFunds",
"riskScore": "low",
"expectedVolumeRange": "0-25000",
"expectedVolumeType": "monthly",
"expectedVolumeCurrency": "GBP",
"businessNatures": "20200",
"companyType": "private",
"website": "https//www.abc.com"
},
"relatedLegalEntities": [
{
"relation": "director",
"identity": {
"type": "individual",
"givenName": "foo",
"familyName": "bar",
"birthDate": "1987-01-01",
"country": "GB"
},
"profile": {
"phone": "",
"addresses": {
"residential": {
"country": "GB",
"postalCode": "12345",
"city": "London",
"street": "122B Baker street"
}
}
}
},
{
"relation": "shareholder",
"identity": {
"type": "corporate",
"country": "GB",
"identificationNumbers": null,
"legalName": "Sub foo bar",
"incorporationDate": "2019-09-09",
"corporationType": null
},
"profile": {
"phone": "",
"addresses": {
"registration": {
"country": "GB",
"postalCode": "12345",
"city": "London",
"street": "122B Baker street"
}
}
}
},
{
"relation": "director-and-shareholder",
"identity": {
"type": "individual",
"givenName": "sub 2 foo",
"familyName": "bar",
"birthDate": "1987-01-01",
"country": "GB"
},
"profile": {
"phone": "",
"addresses": {
"residential": {
"country": "GB",
"postalCode": "12345",
"city": "London",
"street": "122B Baker street"
}
}
}
}
]
}
},
"connect": {},
"metadata": {}
}
Here are the client attributes details of updating a client Client Update API
// the request below only updates the identity & profile & attributes of the individual client
PATCH /clients/<client-id>
{
"workflow": {
"code": "direct"
},
"data": {
"client": {
"identity": {
"type": "individual",
"givenName": "Connect Individual",
"familyName": "Railsbank",
"birthDate": "1996-01-01",
"country": "GB",
"identifications": [
{
"type": "identity-card",
"identificationNumber": "12345677",
"issuingCountry": "GB",
"issueDate": "2022-01-01",
"expirationDate": "2032-01-01"
}
]
},
"profile": {
"identityType": "individual",
"residentialAddress": {
"country": "GB",
"region": "England",
"city": "London",
"street": "Baker Street",
"houseNumber": "221B",
"postalCode": "EC1Y 1AA",
"refinement": ""
},
"phone": "1012555128",
"email": "[email protected]"
},
"attributes": {
"accountUsage": "sendAndReceiveMoneyTransfers",
"riskScore": "low",
"isPep": "false",
"expectedVolumeRange": "5001-10000",
"expectedVolumeType": "monthly",
"expectedVolumeCurrency": "GBP"
}
}
},
"connect": {},
"metadata": {}
}
// the request below only updates the identity & the profile & attributes of the corporate client
PATCH /clients/<client-id>
{
"workflow": {
"code": "direct"
},
"data": {
"client": {
"identity": {
"type": "corporate",
"legalName": "Foo Bar Inc.",
"tradingName": "",
"country": "GB",
"identifications": [
{
"type": "registration-number",
"identificationNumber": "12345678"
}
],
"incorporationDate": "2019-09-09",
"corporationType": "ltd"
},
"profile": {
"registrationAddress": {
"country": "GB",
"region": "Dewsbury Moor",
"city": "Dewsbury",
"street": "98 Low Rd",
"houseNumber": "17",
"postalCode": "WF13 3PS",
"refinement": ""
},
"identityType": "corporate",
"phone": "1012555129",
"email": "[email protected]"
},
"addresses": {
"trading": {
"country": "GB",
"region": "Dewsbury Moor",
"city": "Dewsbury",
"street": "92 Low Rd",
"houseNumber": "21",
"postalCode": "WF13 3PS",
"refinement": ""
}
},
"attributes": {
"accountUsage": "receiveClientFunds",
"riskScore": "low",
"expectedVolumeRange": "0-25000",
"expectedVolumeType": "monthly",
"expectedVolumeCurrency": "GBP",
"businessNatures": "20200",
"companyType": "private",
"website": "https//www.abc.com"
}
}
},
"connect": {},
"metadata": {}
}