Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
This route is used to update advisor's reference data.
Should be called by the organization that created specified advisor record.
It triggers an asynchronous process that will persist this information on the blockchain, which can be monitored using the "Transactions API" endpoints.
This endpoint can be called by applications with access to scope "manageReferenceData".
The unique identifier of the advisor on the blockchain
USS3JKS01I00This property contains the information regarding who is signing the transaction on the blockchain as well as how it will be signed
{"signer":{"email":"[email protected]","name":"John Doe"}}This property contains the advisor reference data information.
{"name":"Charles Schwab","type":"FA","companyName":"Advisor Company","contactInfo":[{"email":"[email protected]","phoneNumber":"+1234950987"}]}PUT /external/v1/advisor/{advisorId} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 231
{
"transactionData": {
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
},
"data": {
"name": "Charles Schwab",
"type": "FA",
"companyName": "Advisor Company",
"contactInfo": [
{
"email": "[email protected]",
"phoneNumber": "+1234950987"
}
]
}
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used to add a correlation ID to an existing advisor. This correlation ID is an externally provided id that uniquely identifies the advisor within the organization making this call.
This correlation ID can't be in use by another advisor. This correlation ID can be broadcast to all the counterparties that have access to this advisor and that have a relationship with the organization making this call.
If the ID is to be broadcast, then it will trigger an asynchronous process (the id of which is returned on the success response) which can be monitored using the "Transactions API" endpoints.
This endpoint can be called by applications with access to scope "manageReferenceData".
The unique identifier of the advisor on the blockchain
USS3JKS01I00Externally provided id that uniquely identifies an entity within an organization.
123245573717This property defines if correlation information will be sent to all counterparties.
falseExample: trueThe organization origin system that created this entity correlation id
Backoffice-system-123This property contains the information regarding who is signing the transaction on the blockchain as well as how it will be signed
{"signer":{"email":"[email protected]","name":"John Doe"}}PUT /external/v1/advisor/{advisorId}/correlation-id/add HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 240
{
"extraData": {
"externalId": "123456789",
"some": "Custom Property"
},
"correlationId": "123245573717",
"broadcastToCounterparty": true,
"origin": "Backoffice-system-123",
"transactionData": {
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
}
}{
"processData": {
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}
}This route is used to remove a correlation ID from an existing advisor. This correlation ID is an externally provided id that uniquely identifies the advisor within the organization making this call.
This correlation ID should be in use by the advisor involved in this call.
This action can be broadcast to all the counterparties that have access to this advisor and that have a relationship with the organization making this call.
If the action is to be broadcast, then it will trigger an asynchronous process (the id of which is returned on the success response) which can be monitored using the "Transactions API" endpoints.
This endpoint can be called by applications with access to scope "manageReferenceData".
The unique identifier of the advisor on the blockchain
USS3JKS01I00Externally provided id that uniquely identifies an entity within an organization.
123245573717This property contains the information regarding who is signing the transaction on the blockchain as well as how it will be signed
{"signer":{"email":"[email protected]","name":"John Doe"}}PUT /external/v1/advisor/{advisorId}/correlation-id/remove HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 176
{
"extraData": {
"externalId": "123456789",
"some": "Custom Property"
},
"correlationId": "123245573717",
"transactionData": {
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
}
}{
"processData": {
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}
}This route is used to retrieve the history data entries of advisors given a set of filters such as blockchain details or advisor identifiers.
The history entries will reflect the state of the advisors on a particular block on the ledger.
This endpoint returns paginated data. Up to 25 can be extracted per call.
This endpoint can be called by applications with access to scope "readAccount".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
The block number where the action was recorded on the ledger.
350The transaction id where the action was recorded on the ledger.
456789OIJHGFCVGHJKLKJHGF67JHPattern: ^[a-zA-Z0-9-]*$The name of the channel where the action was recorded on the ledger.
OG123Pattern: ^[a-zA-Z0-9-]*$The comma delimited list of advisor ids to filter the advisor records. Up to 25 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of advisor correlation ids to filter the advisor records. Up to 25 records can be provided. Each record should not exceed 100 characters.
1234,5678,7890The organization identifier linked to the correlation ids provided in the "advisorCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
GET /external/v1/advisor/history HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"signerData": {
"name": "John Doe",
"email": "[email protected]"
},
"timestamp": "2024-09-12T00:00:00.000Z",
"blockNumber": 350,
"transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
"channelName": "OG123",
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
},
"update": {
"advisorId": "US1W1V3RQK3X",
"type": "FA",
"name": "Charles Schwab",
"organization": {
"orgId": "TEST1234",
"name": "Test Organization"
},
"extraData": {
"some": "Custom Property"
},
"secureExtraData": {
"sensitive": "Data to be protected by application encryption"
}
},
"hash": "$argon2id$v=19$m=4096,t=3,p=1$8AVpNOnlBvN/reiv7Rdkpw$lzXOuG0H4SibMa0elrEZ5sq3YAvdu+Y5L+ta0oSSMTg"
}
]This route is used to retrieve the details of advisors, given a set of search filters.
This endpoint is paginated, up to 25 records can be retrieved per call.
This endpoint can be called by applications with access to scope "readAccount".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
The key to search within the extraData property. Will be used in combination with "extraDataValueFilter". If "extraDataValueFilter" is not provided then this property is discarded.
The value to search within the extraData property. Will be used in combination with "extraDataKeyFilter". If "extraDataKeyFilter" is not provided then this property is discarded.
The comma delimited list of advisor ids to filter the advisor records. Up to 25 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of advisor correlation ids to filter the advisor records. Up to 25 records can be provided. Each record should not exceed 100 characters.
1234,5678,7890The organization identifier linked to the correlation ids provided in the "advisorCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
GET /external/v1/advisor HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"extraData": {
"externalId": "123456789",
"some": "Custom Property"
},
"secureExtraData": {
"some": "Sensitive Data"
},
"name": "text",
"nameDetails": {
"firstName": "John",
"middleName": "Doe",
"lastName": "Smith",
"suffix": "Jr.",
"prefix": "Mr.",
"pronouns": "he/him",
"knownName": "Johnny",
"preferredName": "John",
"title": "Dr."
},
"type": "RIA",
"additionalTypeInfo": "A financial advisor that specializes in retirement planning",
"companyName": "text",
"companyId": "text",
"crdCode": "text",
"repCode": "text",
"contactInfo": {
"email": "[email protected]",
"phoneNumber": "832-426-4242"
},
"branch": "b-12345",
"division": "d-12345",
"advisorId": "text",
"organization": {
"orgId": "TEST1234",
"name": "Test Organization"
},
"correlationData": [
{
"correlationId": "123245573717",
"origin": "Identifies advisor on backoffice",
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
},
"extraData": {
"some": "Custom Property"
}
}
]
}
]This route is used to retrieve the history data entries of advisor correlation ids given a set of filters such as blockchain details or advisor identifiers.
The history entries will reflect the state of the advisor correlation ids on a particular block on the ledger.
This endpoint returns paginated data. Up to 20 can be extracted per call.
This endpoint can be called by applications with access to scope "manageReferenceData".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
The block number where the action was recorded on the ledger.
350The transaction id where the action was recorded on the ledger.
456789OIJHGFCVGHJKLKJHGF67JHPattern: ^[a-zA-Z0-9-]*$The name of the channel where the action was recorded on the ledger.
OG123Pattern: ^[a-zA-Z0-9-]*$The comma delimited list of advisor ids to filter the advisor records. Up to 25 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of advisor correlation ids to filter the advisor records. Up to 25 records can be provided. Each record should not exceed 100 characters.
1234,5678,7890The organization identifier linked to the correlation ids provided in the "advisorCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
GET /external/v1/advisor/correlation-id/history HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"signerData": {
"name": "John Doe",
"email": "[email protected]"
},
"timestamp": "2024-09-12T00:00:00.000Z",
"blockNumber": 350,
"transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
"channelName": "OG123",
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
},
"hash": "$argon2id$v=19$m=4096,t=3,p=1$8AVpNOnlBvN/reiv7Rdkpw$lzXOuG0H4SibMa0elrEZ5sq3YAvdu+Y5L+ta0oSSMTg",
"update": [
{
"correlationId": "123245573717",
"entityType": "investor",
"entityId": "123245573717",
"status": "broadcast",
"origin": "Backoffice-system-123",
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
}
}
]
}
]