Client API Reference
Creates a new Client on the Flagstone platform. The only element that is optional is ‘nonUkTaxObligations’ (country field only is mandatory if Client replies “yes” to having non-UK tax obligations)
Unique reference of the Client from Financial Partner
Client title. Max length 32 characters.
First name of the Client
Last name of the Client
Date of birth of the Client (ISO-8601)
Line 1 of the current address
Line 2 of the current address
Line 3 of the current address
The city or town of the current address
The county of the current address
The post code of the current address
Three-letter Country code of the address (ISO3166)
Phone number
If true, Client is a UK resident
If true, Client is UK domicile
Client's email address
This response is returned when an identical client is already in our system
Unique reference of the Client from Financial Partner
Client title. Max length 32 characters.
First name of the Client
Last name of the Client
Date of birth of the Client (ISO-8601)
Line 1 of the current address
Line 2 of the current address
Line 3 of the current address
The city or town of the current address
The county of the current address
The post code of the current address
Three-letter Country code of the address (ISO3166)
Phone number
If true, Client is a UK resident
If true, Client is UK domicile
Client's email address
This response is returned on initial client creation
This response is returned when the client in the request is malformed
This response is returned when there is an issue with the client that has been requested to be created
POST /clients/financial-partner HTTP/1.1
Host: api.sandbox.flagstoneim.com
cdpapi-Subscription-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 590
{
"externalReference": "GSGEHQ342",
"title": "Mr",
"firstName": "John",
"lastName": "Smith",
"dateOfBirth": "2018-10-01T00:00:00.0000000+00:00",
"addressLine1": "213 Greenway",
"addressLine2": "",
"addressLine3": "",
"city": "Portsmouth",
"county": "Hampshire",
"postCode": "PO122AB",
"countryCode": "GBR",
"phoneNumber": "01980123654",
"ukResident": true,
"ukDomicile": true,
"emailAddress": "b@b.com",
"nonUkTaxObligations": [
{
"countryCode": "USA",
"taxIdentificationNumber": "53464643"
}
],
"accounts": [
{
"accountName": "John Smith",
"accountNumber": "01233234",
"sortCode": "326487",
"bic": "123",
"iban": "4321",
"currencyCode": "GBP"
}
]
}{
"clientReference": "330825e3-a306-4a0f-b722-a6740ec096e6"
}Creates a new company Client on the Flagstone platform
Unique reference of the Client from Financial Partner
Company name of the Client
Is the Client eligible for FSCS protection
FCA Authorisation Number of the Client
Company registration number of the Client
Are there evidence confirming how monies supplied
Does entity have underlying beneficiaries who may be entitled to fund
Line 1 of the current address
Line 2 of the current address
Line 3 of the current address
The city or town of the current address
The county of the current address
The post code of the current address
Three-letter Country code of the address (ISO3166)
Phone number
Client's email address
Created
Invalid property
Conflict
POST /clients/financial-partner/company HTTP/1.1
Host: api.sandbox.flagstoneim.com
cdpapi-Subscription-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 608
{
"externalReference": "71d1fd54-0baa-4356-8637-0eea33675123",
"addressLine1": "213 Greenway",
"addressLine2": "",
"addressLine3": "",
"city": "Portsmouth",
"county": "Hampshire",
"postCode": "PO122AB",
"countryCode": "GBR",
"phoneNumber": "01980123654",
"emailAddress": "js@abc.com",
"companyName": "ABC Limited",
"fscsEligible": true,
"fcaNumber": "326487",
"companyNumber": "1234567",
"hasEvidenceConfirmingHowMoniesAreHeld": true,
"doesEntityHaveUnderlyingBeneficiariesWhoMayBeEntitledToFund": true,
"accounts": [
{
"accountName": "ABC Limited",
"accountNumber": "01233234",
"sortCode": "326487",
"bic": "123",
"iban": "4321",
"currencyCode": "GBP"
}
]
}{
"clientReference": "234256265"
}Returns a Client
The Client is returned
A unique reference to a client provided by external system. Returned via Create Client API and used for Update
Version number of the client
Client title.
First name of the Client
Last name of the Client
Date of birth of the Client (ISO-8601)
Line 1 of the current address
Line 2 of the current address
Line 3 of the current address
The city or town of the current address
The county of the current address
The post code of the current address
Three-letter Country code of the address (ISO3166)
Phone number
If true, Client is a UK resident
If true, Client is UK domicile
Client's email address
Client not found
GET /clients/{clientReference} HTTP/1.1
Host: api.sandbox.flagstoneim.com
cdpapi-Subscription-Key: YOUR_API_KEY
Accept: */*
{
"clientReference": "1231455",
"clientVersion": 3,
"firstName": "John",
"lastName": "Smith",
"dateOfBirth": "1970-10-21T00:00:00.0000000+00:00",
"addressLine1": "213 Greenway",
"addressLine2": "",
"addressLine3": "",
"city": "Portsmouth",
"county": "Hampshire",
"postCode": "PO122AB",
"countryCode": "GBR",
"phoneNumber": "01980123654",
"ukResident": true,
"ukDomicile": true,
"accountName": "John Smith",
"accountNumber": "01233234",
"sortCode": "326487",
"documents": [
{
"documentUri": "http://anExampleLink/2",
"documentType": "driving-license"
},
{
"documentUri": "http://anExampleLink/4",
"documentType": "passport"
}
],
"nonUkTaxObligation": [
{
"countryCode": "USA",
"taxIdentificationNumber": "53464643"
}
]
}Get a company client by client reference for financial partner
Unique reference of the client
OK
A unique reference to a client provided by external system. Returned via Create Client API and used for Update
Version number of the client
Company name of the Client
Is the Client eligible for FSCS protection
FCA Authorisation Number of the Client
Company registration number of the Client
Are there evidence confirming how monies supplied
Does entity have underlying beneficiaries who may be entitled to fund
Line 1 of the current address
Line 2 of the current address
Line 3 of the current address
The city or town of the current address
The county of the current address
The post code of the current address
Three-letter Country code of the address (ISO3166)
Phone number
Client's email address
GET /clients/financial-partner/company/{clientReference} HTTP/1.1
Host: api.sandbox.flagstoneim.com
cdpapi-Subscription-Key: YOUR_API_KEY
Accept: */*
{
"clientReference": "71d1fd54-0baa-4356-8637-0eea33675123",
"clientVersion": 2,
"addressLine1": "213 Greenway",
"addressLine2": "",
"addressLine3": "",
"city": "Portsmouth",
"county": "Hampshire",
"postCode": "PO122AB",
"countryCode": "GBR",
"phoneNumber": "01980123654",
"emailAddress": "js@abc.com",
"companyName": "ABC Limited",
"fscsEligible": true,
"fcaNumber": "326487",
"companyNumber": "1234567",
"hasEvidenceConfirmingHowMoniesAreHeld": true,
"doesEntityHaveUnderlyingBeneficiariesWhoMayBeEntitledToFund": true,
"accounts": [
{
"accountName": "ABC Limited",
"accountNumber": "01233234",
"sortCode": "326487",
"bic": "123",
"iban": "4321",
"currencyCode": "GBP"
}
]
}Update the details of a client
Client title. Max length 32 characters.
First name of the Client
Last name of the Client
Date of birth of the Client (ISO-8601)
Line 1 of the current address
Line 2 of the current address
Line 3 of the current address
The city or town of the current address
The county of the current address
The post code of the current address
Three-letter Country code of the address (ISO3166)
Phone number
If true, Client is a UK resident
If true, Client is UK domicile
Client's email address (Max Length 256)
Client update successful
No content
The request is malformed. For example: "{'errors':['nonUkTaxObligation.CountryCode': 'duplicate']}" "{'errors':['nonUkTaxObligation.CountryCode': 'required']}"
Client with reference not found
A conflict with the existing Client definition occurred
PATCH /clients/{clientReference}/{clientVersion} HTTP/1.1
Host: api.sandbox.flagstoneim.com
cdpapi-Subscription-Key: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 457
{
"firstName": "John",
"lastName": "Smith",
"dateOfBirth": "2018-10-01T00:00:00.0000000+00:00",
"addressLine1": "213 Greenway",
"addressLine2": "",
"addressLine3": "",
"city": "Portsmouth",
"county": "Hampshire",
"postCode": "PO122AB",
"countryCode": "GBR",
"phoneNumber": "01980123654",
"ukResident": true,
"ukDomicile": true,
"accountName": "John Smith",
"accountNumber": "01233234",
"sortCode": "326487",
"nonUkTaxObligation": [
{
"countryCode": "USA",
"taxIdentificationNumber": "53464643"
}
]
}No content
Update detials of a company client
Unique reference of the client
version number of the client
Company name of the Client
Is the Client eligible for FSCS protection
FCA Authorisation Number of the Client
Company registration number of the Client
Are there evidence confirming how monies supplied
Does entity have underlying beneficiaries who may be entitled to fund
Line 1 of the current address
Line 2 of the current address
Line 3 of the current address
The city or town of the current address
The county of the current address
The post code of the current address
Three-letter Country code of the address (ISO3166)
Phone number
Client's email address
No content
Conflict
PATCH /clients/financial-partner/company/{clientReference}/{clientVersion} HTTP/1.1
Host: api.sandbox.flagstoneim.com
cdpapi-Subscription-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 549
{
"addressLine1": "213 Greenway",
"addressLine2": "",
"addressLine3": "",
"city": "Portsmouth",
"county": "Hampshire",
"postCode": "PO122AB",
"countryCode": "GBR",
"phoneNumber": "01980123654",
"emailAddress": "js@abc.com",
"companyName": "ABC Limited",
"fscsEligible": true,
"fcaNumber": "326487",
"companyNumber": "1234567",
"hasEvidenceConfirmingHowMoniesAreHeld": true,
"doesEntityHaveUnderlyingBeneficiariesWhoMayBeEntitledToFund": true,
"accounts": [
{
"accountName": "ABC Limited",
"accountNumber": "01233234",
"sortCode": "326487",
"bic": "123",
"iban": "4321",
"currencyCode": "GBP"
}
]
}No content
Last updated