Tuesday, July 16, 2024

Client - Onboarding Sayari Entity Relationship
Action:
GET
Method:
GET
URL: /api/v1/client/onboardingsayarientityrelationship/get
Description: Fetch Sayari Entity Relationship
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params ClientProspectGroupID Int32 Client Prospect Group Identifier
Params SayariEntityID Int32 Sayari Entity Identifier
Params RelationshipID Int32 Sayari Entity Relationship Identifier
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Sayari Entity Relationship
{
 "BusinessUnitID": 10,
 "ClientProspectGroupID": 50,
 "SayariEntityID": 10,
 "RelationshipID": 208,
 "SayariEntityRelationshipTypeID": 1,
 "SayariEntityRelationshipTypeName": "Shareholder Of",
 "SayariEntityRelationshipTypeReverseName": "Has Shareholder",
 "Title": "Mr.",
 "FirstName": "",
 "MiddleName": "",
 "LastName": "Brevan Howard Capital Management LP",
 "Position": "",
 "Address": "test",
 "IsFormer": false,
 "IsCorporate": false,
 "FirstObserved": "2012-03-19",
 "LastObserved": "2021-03-04",
 "ClientProspectID": 450403,
 "ClientOnboardingID": 300408,
 "ParentClientProspectID": 450402
 "SayariEntityUniqueReference": "-ts_IvDyU6a7S0D6WOrkjQ"
 "SayariRecordUniqueReferenceList": []
 "Deleted": false
}
Field Data Type
BusinessUnitID Int32
ProspectGroupID Int32
SayariEntityID Int32
RelationshipID Int32
SayariEntityRelationshipTypeID Byte
SayariEntityRelationshipTypeName Text
SayariEntityRelationshipTypeReverseName Text
Title Text 10
FirstName Text 150
MiddleName Text 150
LastName Text 150
Position Text 100
Address Text 500
IsFormer Boolean
IsCorporate Boolean
FirstObserved Date
LastObserved Date
ClientProspectID Int32
ClientOnboardingID Int32
ParentClientProspectID Int32
SayariEntityUniqueReference Text 200
SayariRecordUniqueReferenceList String[]
Deleted Boolean
Action:
GET ALL
Method:
GET
URL: /api/v1/client/onboardingsayarientityrelationship/getall
Description: Fetch Entity Relationships for Sayari Entity
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params ClientProspectGroupID Int32 Client Prospect Group Identifier
Params SayariEntityID Int32 Sayari Entity Identifier
Params ReturnFormat String Json or Xml
Return Data: Json or XML collection of Client Onboarding Sayari Entity Relationships
[{
 "BusinessUnitID": 10,
 "ClientProspectGroupID": 50,
 "SayariEntityID": 10,
 "RelationshipID": 208,
 "SayariEntityRelationshipTypeID": 1,
 "SayariEntityRelationshipTypeName": "Shareholder Of",
 "SayariEntityRelationshipTypeReverseName": "Has Shareholder",
 "Title": "Mr.",
 "FirstName": "",
 "MiddleName": "",
 "LastName": "Brevan Howard Capital Management LP",
 "Position": "",
 "Address": "test",
 "IsFormer": false,
 "IsCorporate": false,
 "FirstObserved": "2012-03-19",
 "LastObserved": "2021-03-04",
 "ClientProspectID": 450403,
 "ClientOnboardingID": 300408,
 "ParentClientProspectID": 450402
 "SayariEntityUniqueReference": "-ts_IvDyU6a7S0D6WOrkjQ"
 "SayariRecordUniqueReferenceList": []
 "Deleted": false
}]
Field Data Type
BusinessUnitID Int32
ProspectGroupID Int32
SayariEntityID Int32
RelationshipID Int32
SayariEntityRelationshipTypeID Byte
SayariEntityRelationshipTypeName Text
SayariEntityRelationshipTypeReverseName Text
Title Text 10
FirstName Text 150
MiddleName Text 150
LastName Text 150
Position Text 100
Address Text 500
IsFormer Boolean
IsCorporate Boolean
FirstObserved Date
LastObserved Date
ClientProspectID Int32
ClientOnboardingID Int32
ParentClientProspectID Int32
SayariEntityUniqueReference Text 200
SayariRecordUniqueReferenceList String[]
Deleted Boolean
Action:
ADD
Method:
POST
URL: /api/v1/client/onboardingsayarientityrelationship/add
Description: Add Sayari Entity Relationship
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Body ClientProspectGroupID Int32 Client Prospect Group Identifier
Body SayariEntityID Int32 Sayari Entity Identifier
Body SayariEntityRelationshipTypeID Byte Sayari Entity Relationship Type Identifier (Unknown = 0, Translated Name = 1, Additional Information = 2, Country = 3, Contact = 4, Status = 5, Finances = 6, Business Purpose = 7, Shares = 8, Date Of Birth = 9, Address = 10, Identifier = 11, Position = 12, Gender = 13, Company Type = 14, Name = 15, Weak Identifier = 16)
Body Title Text 10 Title
Body FirstName Text 150 First Name
Body MiddleName Text 150 Middle Name
Body LastName Text 150 Last Name
Body Position Text 100 Position
Body Address Text 500 Address
Body IsFormer Boolean Is Former Relationship?
Body FirstObserved Text 20 First Observed Date[-Month][-Year]
Body LastObserved Text 20 Last Observed Date[-Month][-Year]
Body IsCorporate Boolean Is Corporate?
Body ClientProspectID Int32 Client Prospect Identifier
Body ClientOnboardingID Int32 Client Onboarding Identifier
Body ParentClientProspectID Int32 Parent Client Prospect Identifier
Body SayariEntityUniqueReference Text 200 Sayari Entity Unique Reference
Body Deleted Boolean Is Deleted?
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Sayari Entity Relationship added.
{
 "BusinessUnitID": 10,
 "ClientProspectGroupID": 50,
 "SayariEntityID": 10,
 "RelationshipID": 208,
 "SayariEntityRelationshipTypeID": 1,
 "SayariEntityRelationshipTypeName": "Shareholder Of",
 "SayariEntityRelationshipTypeReverseName": "Has Shareholder",
 "Title": "Mr.",
 "FirstName": "",
 "MiddleName": "",
 "LastName": "Brevan Howard Capital Management LP",
 "Position": "",
 "Address": "test",
 "IsFormer": false,
 "IsCorporate": false,
 "FirstObserved": "2012-03-19",
 "LastObserved": "2021-03-04",
 "ClientProspectID": 450403,
 "ClientOnboardingID": 300408,
 "ParentClientProspectID": 450402
 "SayariEntityUniqueReference": "-ts_IvDyU6a7S0D6WOrkjQ"
 "SayariRecordUniqueReferenceList": []
 "Deleted": false
}
Field Data Type
ClientOnboardingSayariEntityRelatonship Collection
 Same as Get Method results above.
Action:
UPDATE
Method:
PUT
URL: /api/v1/client/onboardingsayarientityrelationship/update
Description: Update Sayari Entity Relationship
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Body ClientProspectGroupID Int32 Client Prospect Group Identifier
Body SayariEntityID Int32 Sayari Entity Identifier
Body RelationshipID Int32 Sayari Entity Relationship Identifier
Body SayariEntityRelationshipTypeID Byte Sayari Entity Relationship Type Identifier (Unknown = 0, Translated Name = 1, Additional Information = 2, Country = 3, Contact = 4, Status = 5, Finances = 6, Business Purpose = 7, Shares = 8, Date Of Birth = 9, Address = 10, Identifier = 11, Position = 12, Gender = 13, Company Type = 14, Name = 15, Weak Identifier = 16)
Body Title Text 10 Title
Body FirstName Text 150 First Name
Body MiddleName Text 150 Middle Name
Body LastName Text 150 Last Name
Body Position Text 100 Position
Body Address Text 500 Address
Body IsFormer Boolean Is Former Relationship?
Body FirstObserved Text 20 First Observed Date[-Month][-Year]
Body LastObserved Text 20 Last Observed Date[-Month][-Year]
Body IsCorporate Boolean Is Corporate?
Body ClientProspectID Int32 Client Prospect Identifier
Body ClientOnboardingID Int32 Client Onboarding Identifier
Body ParentClientProspectID Int32 Parent Client Prospect Identifier
Body SayariEntityUniqueReference Text 200 Sayari Entity Unique Reference
Body Deleted Boolean Is Deleted?
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Sayari Entity Relationship updated.
{
 "BusinessUnitID": 10,
 "ClientProspectGroupID": 50,
 "SayariEntityID": 10,
 "RelationshipID": 208,
 "SayariEntityRelationshipTypeID": 1,
 "SayariEntityRelationshipTypeName": "Shareholder Of",
 "SayariEntityRelationshipTypeReverseName": "Has Shareholder",
 "Title": "Mr.",
 "FirstName": "",
 "MiddleName": "",
 "LastName": "Brevan Howard Capital Management LP",
 "Position": "",
 "Address": "test",
 "IsFormer": false,
 "IsCorporate": false,
 "FirstObserved": "2012-03-19",
 "LastObserved": "2021-03-04",
 "ClientProspectID": 450403,
 "ClientOnboardingID": 300408,
 "ParentClientProspectID": 450402
 "SayariEntityUniqueReference": "-ts_IvDyU6a7S0D6WOrkjQ"
 "SayariRecordUniqueReferenceList": []
 "Deleted": false
}
Field Data Type
ClientOnboardingSayariEntityRelatonship Collection
 Same as Get Method results above.
Action:
DELETE
Method:
DELETE
URL: /api/v1/client/onboardingsayarientityrelationship/delete
Description: Delete Sayari Entity Relationship
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Body ClientProspectGroupID Int32 Client Prospect Group Identifier
Body SayariEntityID Int32 Sayari Entity Identifier
Body RelationshipID Int32 Sayari Entity Relationship Identifier
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Sayari Entity Relationship deleted.
{
 "BusinessUnitID": 10,
 "ClientProspectGroupID": 50,
 "SayariEntityID": 10,
 "RelationshipID": 208,
 "SayariEntityRelationshipTypeID": 1,
 "SayariEntityRelationshipTypeName": "Shareholder Of",
 "SayariEntityRelationshipTypeReverseName": "Has Shareholder",
 "Title": "Mr.",
 "FirstName": "",
 "MiddleName": "",
 "LastName": "Brevan Howard Capital Management LP",
 "Position": "",
 "Address": "test",
 "IsFormer": false,
 "IsCorporate": false,
 "FirstObserved": "2012-03-19",
 "LastObserved": "2021-03-04",
 "ClientProspectID": 450403,
 "ClientOnboardingID": 300408,
 "ParentClientProspectID": 450402
 "SayariEntityUniqueReference": "-ts_IvDyU6a7S0D6WOrkjQ"
 "SayariRecordUniqueReferenceList": []
 "Deleted": false
} }
Field Data Type
ClientOnboardingSayariEntityRelatonship Collection
 Same as Get Method results above.