{"openapi":"3.0.3","servers":[{"url":"https://banqu.app:443/api/v1"}],"info":{"title":"BanQu API","version":"3.3.4","description":"The BanQu API is organized around [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP verbs, which can be understood by off-the-shelf HTTP clients, and [JSON](http://www.json.org) for input and output."},"paths":{"/auth/api-tokens":{"post":{"description":"Create persistent token for API requests authentication.\nToken will be written to the response body only once and will not be stored within the BanQu system","tags":["Authentication"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiTokenCreationParameters"}}},"required":true},"responses":{"200":{"description":"JWT encoded API access token","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"422":{"$ref":"#/components/responses/422"}}},"get":{"description":"Get available API tokens","tags":["Authentication"],"responses":{"200":{"description":"API tokens","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiTokenInfo"}}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}}}},"/auth/api-tokens/{id}":{"parameters":[{"name":"id","description":"API token identifier","in":"path","schema":{"type":"string"},"required":true}],"delete":{"description":"Remove API token","tags":["Authentication"],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}}}},"/auth/accounts":{"get":{"description":"List available accounts","tags":["Authentication"],"responses":{"200":{"description":"List of accounts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccountInfo"}}}}},"401":{"$ref":"#/components/responses/401"}}}},"/auth/accounts/{accountId}/token":{"post":{"description":"Create account-specific short-lived authentication token","tags":["Authentication"],"parameters":[{"in":"path","name":"accountId","schema":{"type":"string"},"required":true}],"responses":{"200":{"$ref":"#/components/schemas/AuthTokens"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/auth/signup":{"post":{"description":"Sign up user","tags":["Authentication"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignUp"}}},"required":true},"responses":{"200":{"$ref":"#/components/schemas/AuthTokens"},"400":{"$ref":"#/components/responses/400"}}}},"/auth/signup/{token}":{"parameters":[{"in":"path","name":"token","schema":{"type":"string"},"required":true}],"get":{"description":"Get user invite info","tags":["Authentication"],"responses":{"200":{"$ref":"#/components/schemas/InviteInfo"},"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}}},"post":{"description":"Sign up user by invite","tags":["Authentication"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignUpWithToken"}}},"required":true},"responses":{"200":{"$ref":"#/components/schemas/AuthTokens"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}}}},"/profile":{"get":{"description":"Get logged in user profile","tags":["User Profile"],"responses":{"200":{"description":"User profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExistentProfile"}}}},"401":{"$ref":"#/components/responses/401"}}},"patch":{"description":"Modify logged in user profile","tags":["User Profile"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExistentProfile"}}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExistentProfile"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}}},"/profile/password":{"post":{"description":"Update logged in user password","tags":["User Profile"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"oldPassword":{"type":"string"},"password":{"type":"string"}}}}}},"responses":{"200":{"description":"Password changed successfully"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}}},"/profile/photo":{"get":{"description":"Get logged in user photo","tags":["User Profile"],"responses":{"302":{"description":"Redirect to the Photo url","headers":{"Location":{"schema":{"type":"string"},"description":"Photo URL"}}},"404":{"$ref":"#/components/responses/404"}}},"post":{"description":"Update logged in user photo","tags":["User Profile"],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"string","format":"binary"}}}},"responses":{"201":{"$ref":"#/components/responses/201"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}}},"/profile/sections":{"get":{"description":"List logged in user profile sections","tags":["User Profile"],"responses":{"200":{"description":"List of profile sections","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileSectionsList"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}}},"/profile/standard":{"get":{"description":"List standard profile sections","tags":["User Profile"],"responses":{"200":{"description":"List of profile sections","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileSectionsList"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}}},"/profile/forms":{"get":{"description":"List profile section forms","tags":["User Profile"],"responses":{"200":{"description":"List of profile forms","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Form"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}}},"/profile/forms/{formId}":{"get":{"description":"Get profile section form details","parameters":[{"name":"formId","description":"FormId from profile section","in":"path","schema":{"type":"string"},"required":true}],"tags":["User Profile"],"responses":{"200":{"description":"Profile form template","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Form"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}}},"/profile/sharing":{"get":{"description":"Get profile sharing settings","tags":["User Profile Sharing"],"responses":{"200":{"description":"Sharing settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileVisibility"}}}},"401":{"$ref":"#/components/responses/401"}}},"patch":{"description":"Change profile sharing settings","tags":["User Profile Sharing"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileVisibility"}}}},"responses":{"200":{"description":"Sharing settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileVisibility"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}}},"/profile-shared-packages":{"get":{"tags":["User Profile Sharing"],"description":"List packaged profile shares","responses":{"200":{"description":"List of profile share packages","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PackagedShareProfileListItem"}}}}},"401":{"$ref":"#/components/responses/401"}}},"post":{"tags":["User Profile Sharing"],"description":"Create packaged profile share","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewPackagedShareProfile"}}}},"responses":{"201":{"$ref":"#/components/responses/201"},"401":{"$ref":"#/components/responses/401"}}}},"/profile-shared-packages/{id}":{"get":{"tags":["User Profile Sharing"],"description":"Get packaged profile share details","parameters":[{"name":"id","description":"sharing id","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Particular packaged share profile data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackagedShareProfile"}}}}}},"delete":{"tags":["User Profile Sharing"],"description":"Delete packaged profile share","parameters":[{"name":"id","description":"sharing id","in":"path","schema":{"type":"string"},"required":true}],"responses":{"204":{"$ref":"#/components/responses/204"}}}},"/profile-shared-packages/{id}/assets":{"parameters":[{"name":"id","description":"sharing id","in":"path","schema":{"type":"string"},"required":true}],"get":{"tags":["User Profile Sharing"],"parameters":[{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/SortBy"}],"description":"List packaged profile share assets","responses":{"200":{"description":"A list of assets","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SharedAssets"}}}}},"401":{"$ref":"#/components/responses/401"}}}},"/profile-shared-packages/{id}/transactions":{"get":{"tags":["User Profile Sharing"],"description":"List packaged profile share transactions","parameters":[{"name":"id","description":"sharing id","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"A list of transactions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Transaction"}}}}},"401":{"$ref":"#/components/responses/401"}}}},"/profile-shared-packages/{id}/connections":{"get":{"tags":["User Profile Sharing"],"description":"List packaged profile share connections","parameters":[{"name":"id","description":"sharing id","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"A list of connections","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Connection"}}}}},"401":{"$ref":"#/components/responses/401"}}}},"/profile-shared-packages/{id}/asset-categories":{"get":{"tags":["User Profile Sharing"],"description":"List packaged profile share categories","parameters":[{"name":"id","description":"sharing id","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"A list of asset categories","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetCategory"}}}}},"401":{"$ref":"#/components/responses/401"}}}},"/profile-shared-packages/{id}/geo-data":{"get":{"parameters":[{"name":"id","description":"sharing id","in":"path","schema":{"type":"string"},"required":true}],"description":"Get GeoJSON data from shared Profile Sections","tags":["User Profile Sharing"],"responses":{"200":{"description":"Successful response containing the GeoJSON object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeoJsonFeatureCollection"}}}}}}},"/profile/shares":{"get":{"tags":["User Profile Sharing"],"description":"List profile shares","responses":{"200":{"description":"List of profile shares","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProfileShareRequests"}}}}}}},"post":{"tags":["User Profile Sharing"],"description":"Create profile share","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"receiverId":{"description":"User or Org id","type":"string"},"sections":{"type":"array","items":{"type":"string","uniqueItems":true}},"expiresAt":{"type":"number","description":"expiration time in milliseconds"}},"required":["receiverId","sections"]}}}},"responses":{"201":{"$ref":"#/components/responses/201"},"403":{"$ref":"#/components/responses/403"},"422":{"$ref":"#/components/responses/422"}}}},"/profile/shares/{otherPartyId}":{"parameters":[{"name":"otherPartyId","description":"User or Org id","in":"path","schema":{"type":"string"},"required":true}],"get":{"tags":["User Profile Sharing"],"description":"Get profile share request details","responses":{"200":{"description":"A certain share request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareRequest"}}}},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}},"delete":{"tags":["User Profile Sharing"],"description":"Delete/reject profile share request","responses":{"204":{"$ref":"#/components/responses/204"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/422"}}}},"/profile/shares/{senderId}/approve":{"post":{"tags":["User Profile Sharing"],"description":"Accept profile share request","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"expiresAt":{"type":"number","description":"expiration time in milliseconds"}}}}}},"parameters":[{"name":"senderId","description":"User or Org id","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Request was approved"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/422"}}}},"/shared-profile/{ownerId}":{"parameters":[{"name":"ownerId","description":"User or Org account ID","in":"path","schema":{"type":"string"},"required":true}],"get":{"security":[],"tags":["Public Profiles"],"description":"Get public profile","responses":{"200":{"description":"An user or organization profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExistentProfile"}}}},"404":{"$ref":"#/components/responses/404"}}}},"/shared-profile/{ownerId}/forms":{"parameters":[{"name":"ownerId","description":"User or Org account ID","in":"path","schema":{"type":"string"},"required":true}],"get":{"security":[],"description":"Get forms describing shared profile sections","tags":["Public Profiles"],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Form"}}}}},"404":{"$ref":"#/components/responses/404"}}}},"/shared-profile/{ownerId}/related-data-entries":{"parameters":[{"name":"ownerId","description":"User or Org account ID","in":"path","schema":{"type":"string"},"required":true}],"get":{"security":[],"description":"Get data entries related to the profile","tags":["Public Profiles"],"parameters":[{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/SortBy"},{"name":"status","in":"query","schema":{"type":"string","enum":["all","pending","submitted","reviewed","rejected","approved","denied","archived"]},"description":"Data entry status filter","required":false}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FormDataEntry"}}}}}}}},"/shared-profile/{ownerId}/geo-data":{"parameters":[{"name":"ownerId","description":"User or Org account ID","in":"path","schema":{"type":"string"},"required":true}],"get":{"description":"Get GeoJSON data from related Data Entries and Profile Forms","tags":["Public Profiles"],"parameters":[{"name":"status","in":"query","schema":{"type":"string","enum":["all","pending","submitted","reviewed","rejected","approved","denied","archived"]},"description":"Data entry status filter","required":false}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeoJsonFeatureCollection"}}}}}}},"/shared-profile/{ownerId}/connections":{"get":{"security":[],"tags":["Public Profiles"],"description":"List public profile connections","parameters":[{"name":"ownerId","description":"User or Org id","in":"path","schema":{"type":"string"},"required":true},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/SortBy"}],"responses":{"200":{"description":"Public profile connections","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Connection"}}}}},"404":{"$ref":"#/components/responses/404"}}}},"/shared-profile/{ownerId}/assets":{"parameters":[{"name":"ownerId","description":"User or Org account ID","in":"path","schema":{"type":"string"},"required":true}],"get":{"security":[],"tags":["Public Profiles"],"description":"List public profile assets","parameters":[{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/SortBy"}],"responses":{"200":{"description":"Get shared assets","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SharedAssets"}}}}}}}},"/shared-profile/{ownerId}/transactions":{"parameters":[{"name":"ownerId","description":"User or Org account ID","in":"path","schema":{"type":"string"},"required":true}],"get":{"security":[],"tags":["Public Profiles"],"description":"List public profile transactions","parameters":[{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/SortBy"}],"responses":{"200":{"description":"Get shared transactions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SharedTransaction"}}}}},"404":{"$ref":"#/components/responses/404"}}}},"/shared-profile/{ownerId}/transactions/{transactionId}/operations":{"parameters":[{"name":"ownerId","description":"User or Org account ID","in":"path","schema":{"type":"string"},"required":true},{"name":"transactionId","description":"shared transactions ID","in":"path","schema":{"type":"string"},"required":true}],"get":{"security":[],"tags":["Public Profiles"],"description":"List public profile transaction operations","responses":{"200":{"description":"Get shared transaction operations","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SharedOperations"}}}}},"404":{"$ref":"#/components/responses/404"}}}},"/shared-profile/{ownerId}/requests":{"parameters":[{"name":"ownerId","description":"User or Org account ID","in":"path","schema":{"type":"string"},"required":true}],"post":{"tags":["Public Profiles"],"description":"Send profile share request","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"expiresAt":{"$ref":"#/components/schemas/Timestamp"},"sections":{"type":"array","items":{"type":"string"},"uniqueItems":true}}}}}},"responses":{"201":{"$ref":"#/components/responses/201"},"403":{"$ref":"#/components/responses/403"},"422":{"$ref":"#/components/responses/422"}}}},"/shared-profile/{ownerId}/households":{"parameters":[{"name":"ownerId","description":"User or Org account ID","in":"path","schema":{"type":"string"},"required":true}],"get":{"security":[],"description":"List public profile households. If ownerId is a head of household result contains list of members including himself. If ownerId is dependent result contains all heads of households ownerId is member of","tags":["Public Profiles"],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ShallowProfile"}}}}},"404":{"$ref":"#/components/responses/404"}}}},"/orgs":{"get":{"description":"Get list of Org accounts user participates in","tags":["Organizations"],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserOrg"}}}}}}},"post":{"description":"Create org account","tags":["Organizations"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"Name of the Organization","type":"string","minLength":3,"maxLength":100},"isChild":{"description":"Should new account be a child account of the org user signed into","type":"boolean"}},"additionalProperties":false,"required":["name"]}}}},"responses":{"201":{"$ref":"#/components/responses/201"}}}},"/orgs/{orgId}":{"parameters":[{"name":"orgId","in":"path","schema":{"type":"string"},"required":true}],"get":{"description":"Get org account details","tags":["Organizations"],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Org"}}}},"404":{"$ref":"#/components/responses/404"}}},"patch":{"description":"Modify org account details","tags":["Organizations"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Org"}}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Org"}}}},"404":{"$ref":"#/components/responses/404"}}},"delete":{"description":"Deactivate org account","tags":["Organizations"],"responses":{"204":{"$ref":"#/components/responses/204"},"404":{"$ref":"#/components/responses/404"}}}},"/orgs/{orgId}/restore":{"post":{"description":"Reactivate org account","tags":["Organizations"],"parameters":[{"name":"orgId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"204":{"$ref":"#/components/responses/204"},"404":{"$ref":"#/components/responses/404"}}}},"/orgs/{orgId}/private-labeling":{"parameters":[{"name":"orgId","in":"path","schema":{"type":"string"},"required":true}],"get":{"description":"get enterprise settings","tags":["Organizations"],"responses":{"200":{"description":"Changes successfully applied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivateLabeling"}}}},"403":{"$ref":"#/components/responses/403"}}},"post":{"description":"Apply changes to Enterprise.","tags":["Organizations"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivateLabeling"}}}},"responses":{"200":{"description":"Changes successfully applied"},"403":{"$ref":"#/components/responses/403"}}}},"/orgs/{orgId}/license":{"parameters":[{"name":"orgId","in":"path","schema":{"type":"string"},"required":true}],"get":{"description":"Get org account license. Specifies count limits of associates with admin privileges","tags":["Organizations"],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/License"}}}}}}},"/orgs/{orgId}/sharing":{"parameters":[{"name":"orgId","in":"path","schema":{"type":"string"},"required":true}],"get":{"description":"Get org account public profile settings","tags":["Organizations"],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileVisibility"}}}}}},"patch":{"description":"Modify org account public profile settings","tags":["Organizations"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileVisibility"}}}},"responses":{"204":{"$ref":"#/components/responses/204"}}}},"/orgs/current/profile-forms":{"get":{"description":"Get a list of forms describing Org profile","tags":["Organizations"],"responses":{"200":{"description":"List of forms","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Form"}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}}}},"/orgs/current/associates":{"get":{"description":"List org account associates","tags":["Organization Associates"],"responses":{"200":{"description":"List of current org associates","content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/OrgAssociate"},{"$ref":"#/components/schemas/OrgAssociateInvite"}]}}}}}}},"post":{"description":"Add org account associate","tags":["Organization Associates"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgAssociateInvite"}}}},"responses":{"201":{"$ref":"#/components/responses/201"},"202":{"$ref":"#/components/responses/202"}}}},"/orgs/current/associates/{userId}":{"patch":{"description":"Modify org associate/invite roles","tags":["Organization Associates"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgAssociatePatch"}}}},"parameters":[{"name":"userId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"204":{"$ref":"#/components/responses/204"}}},"delete":{"description":"Remove org associate/invite","tags":["Organization Associates"],"parameters":[{"name":"userId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"204":{"$ref":"#/components/responses/204"}}}},"/orgs/current/roles":{"get":{"description":"List roles available in current org account","tags":["Organization Roles"],"responses":{"200":{"description":"List of roles in organization","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/OrgRole"},{"$ref":"#/components/schemas/ScimResourceMetadata"}]}}}}},"404":{"$ref":"#/components/responses/404"}}},"post":{"description":"Create org account role","tags":["Organization Roles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"$ref":"#/components/schemas/EditableOrgRole"}},"required":["role"]}}}},"responses":{"204":{"$ref":"#/components/responses/201"},"400":{"$ref":"#/components/responses/400"}}}},"/orgs/current/roles/{roleId}":{"patch":{"description":"Modify org account role","tags":["Organization Roles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"$ref":"#/components/schemas/EditableOrgRole"}},"required":["role"]}}}},"parameters":[{"in":"path","name":"roleId","description":"ID of the role to modify","schema":{"type":"string"},"required":true}],"responses":{"204":{"$ref":"#/components/responses/201"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}}},"delete":{"description":"Remove org account role","tags":["Organization Roles"],"parameters":[{"in":"path","name":"roleId","description":"ID of the role to modify","schema":{"type":"string"},"required":true}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}}}},"/orgs/current/capabilities":{"get":{"description":"List all organization capabilities","tags":["Organization Roles"],"responses":{"200":{"description":"List of roles in organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgCapabilities"}}}}}}},"/orgs/{orgId}/features":{"get":{"description":"List all available organization features","tags":["Organization Features"],"parameters":[{"in":"path","name":"orgId","description":"ID of the org to modify or \"current\"","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"List of features in organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgFeatures"}}}}}},"post":{"description":"Set organization features","tags":["Organization Features"],"parameters":[{"in":"path","name":"orgId","description":"ID of the org to modify or \"current\"","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"features":{"type":"array","uniqueItems":true,"items":{"pattern":"^\\S+$","type":"string"}}},"required":["features"]}}}},"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}},"/connections":{"get":{"description":"List connections/invites","tags":["Connections"],"parameters":[{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/SortBy"},{"$ref":"#/components/parameters/Search"},{"name":"status","in":"query","schema":{"type":"string","enum":["connected","pending-incoming"]},"description":"Filter by connection status","required":false}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Connection"}}}},"headers":{"X-Total-Count":{"schema":{"type":"number"},"description":"Total number of connections available for paging purposes"}}},"401":{"$ref":"#/components/responses/401"}}},"post":{"description":"Create identity or send connection invite","tags":["Connections"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionCreatePayload"}}}},"responses":{"201":{"description":"Connection invite or identity profile is created"},"202":{"description":"User invited to BanQu"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}}},"/connections/filter":{"post":{"description":"Search connections and filter them by specific form fields","tags":["Connections"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"filter":{"$ref":"#/components/schemas/ConnectionFilter"}}}}}},"parameters":[{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/SortBy"},{"$ref":"#/components/parameters/Search"},{"name":"status","in":"query","schema":{"type":"string","enum":["connected","pending-incoming"]},"description":"Filter by connection status","required":false}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Connection"}}}},"headers":{"X-Total-Count":{"schema":{"type":"number"},"description":"Total number of found connections available for paging purposes"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}}},"/connections/csv":{"get":{"description":"Export connections to CSV","tags":["Connections"],"parameters":[{"name":"method","in":"query","schema":{"type":"string","enum":["pretty","simple"]},"description":"Sets output format. \"simple\" is default. \"pretty\" provides field titles in header, formatted dates, list items, hides system information. \"simple\" gives JSON names in header and all available unformatted data","required":false},{"name":"excludeColumns","in":"query","schema":{"type":"string"},"description":"Comma-separated list of JSON names of fields to be omitted","required":false}],"responses":{"200":{"description":"Ok","content":{"text/csv;":{"schema":{"type":"string"}}},"headers":{"content-type":{"schema":{"type":"string"},"description":"text/csv;charset=utf-8"},"content-disposition":{"schema":{"type":"string"},"description":"Proposed file name"}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}}}},"/connections/{connectionId}":{"get":{"description":"Get connection details","tags":["Connections"],"parameters":[{"$ref":"#/components/parameters/connectionId"}],"responses":{"200":{"description":"Connection details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}},"patch":{"description":"Change connection details","tags":["Connections"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Resource"},{"$ref":"#/components/schemas/ConnectionExtension"},{"type":"object","properties":{"lastModified":{"type":"number"}}}]}}}},"parameters":[{"$ref":"#/components/parameters/connectionId"}],"responses":{"200":{"$ref":"#/components/responses/NewProfileTimestamp"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}},"delete":{"description":"Delete connection/invite","tags":["Connections"],"parameters":[{"$ref":"#/components/parameters/connectionId"}],"responses":{"200":{"description":"Connection deleted"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}},"put":{"description":"Create connection","tags":["Connections"],"parameters":[{"name":"newConnectionId","description":"New Connection ID (UUID without dashes)","in":"path","schema":{"type":"string","pattern":"^[0-9a-f]{32}$"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionCreatePayload"}}}},"responses":{"201":{"description":"Connection profile is created"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"409":{"$ref":"#/components/responses/409"},"422":{"$ref":"#/components/responses/422"}}}},"/connections/{connectionId}/resend":{"post":{"description":"Resend connection invite","tags":["Connections"],"parameters":[{"$ref":"#/components/parameters/connectionId"}],"responses":{"200":{"description":"Connection invite resent"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/connections/{connectionId}/accept":{"post":{"description":"Accept connection invite","tags":["Connections"],"parameters":[{"$ref":"#/components/parameters/connectionId"}],"responses":{"200":{"description":"Connection invite accepted"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/connections/{connectionId}/roles":{"post":{"description":"Grant roles to connected identity","tags":["Connections"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"roles":{"type":"array","items":{"type":"string"}}},"required":["roles"]}}}},"parameters":[{"$ref":"#/components/parameters/connectionId"}],"responses":{"200":{"$ref":"#/components/responses/NewProfileTimestamp"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}},"delete":{"description":"Revoke roles from connected identity","tags":["Connections"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"roles":{"type":"array","items":{"type":"string"}}},"required":["roles"]}}}},"parameters":[{"$ref":"#/components/parameters/connectionId"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/connections/{connectionId}/features":{"post":{"description":"Assign features to connected identity","tags":["Connections"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"features":{"description":"Values are limited to keys returned by `/orgs/current/features` endpoint","type":"array","items":{"type":"string"}}},"required":["features"]}}}},"parameters":[{"$ref":"#/components/parameters/connectionId"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}},"delete":{"description":"Delete features from connected identity","tags":["Connections"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"features":{"description":"Values are limited to keys returned by `/orgs/current/features` endpoint","type":"array","items":{"type":"string"}}},"required":["features"]}}}},"parameters":[{"$ref":"#/components/parameters/connectionId"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/connections/{connectionId}/profile":{"patch":{"description":"Modify connected identity profile","tags":["Connections"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionProfileUpdatePayload"}}}},"parameters":[{"$ref":"#/components/parameters/connectionId"}],"responses":{"200":{"description":"HTTP 200 - Profile modification successful","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"lastModified":{"type":"number","description":"If profile was modified, contains new `lastModifed` timestamp"}},"required":["id"]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/connections/{connectionId}/assets":{"get":{"description":"List connected identity assets","tags":["Connections","Assets"],"parameters":[{"$ref":"#/components/parameters/connectionId"}],"responses":{"200":{"description":"A list of connection assets","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Asset"},{"$ref":"#/components/schemas/ScimResourceMetadata"}]}}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/connections/{connectionId}/dependents":{"post":{"description":"Add connected identity household member. This effectively creates a connection between two users and sets \"parent\" role to the head","tags":["Connections"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"memberId":{"type":"string","description":"userId (UUID) or verified email or verified phone number of household member candidate"}},"required":["memberId"]}}}},"parameters":[{"$ref":"#/components/parameters/connectionId"}],"responses":{"201":{"description":"HTTP 201 - Created \nHousehold member successfully added","headers":{"Location":{"schema":{"type":"string"},"description":"Url of the created entity"}}},"204":{"description":"HTTP 204 - No Content \nNo action taken. Identity is already a member of given household "},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"422":{"description":"HTTP 422 - Unprocessable Request \nOne of given identities already has membership in a different household"}}},"delete":{"description":"Remove connected identity household member. Revokes \"parent\" role on member's connection to the head","tags":["Connections"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"memberId":{"type":"string","description":"userId (UUID) or verified email or verified phone number of household member candidate"}},"required":["memberId"]}}}},"parameters":[{"$ref":"#/components/parameters/connectionId"}],"responses":{"200":{"description":"HTTP 200 - OK \nHousehold member successfully removed"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"description":"HTTP 404 - Not Found \nIdentity is not a member of given household"},"422":{"description":"HTTP 422 - Unprocessable Request \nOne of given identities already has membership in a different household"}}}},"/connections/{connectionId}/destinations":{"get":{"description":"List available payment destinations for the connection","tags":["Connections"],"parameters":[{"$ref":"#/components/parameters/connectionId"},{"in":"query","name":"claimableAsset","schema":{"type":"string"},"description":"a true/false flag to indicate if claimable asset providers is returned"},{"in":"query","name":"monetaryAsset","schema":{"type":"string"},"description":"a true/false flag to indicate if monetary providers is returned"}],"responses":{"200":{"description":"A list of connection available payment destinations for the connection","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"provider":{"type":"string","enum":["banqu-agency"]}},"required":["id","name","provider"]},{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"fees":{"type":"array","items":{"type":"object","properties":{"max":{"type":"number"},"add":{"type":"number"}}}},"error":{"type":"string"},"type":{"type":"string","enum":["mobile"]},"currency":{"type":"string"},"provider":{"type":"string","enum":["mtn-uganda","6dot50pay-zaf","mtn-zambia","tigo-tanzania","celbux-zaf","airtel","zamtel","vodacom"]}},"required":["name","id","type","currency","provider"]}]}}}},"401":{"$ref":"#/components/responses/401"}}}},"/assets":{"get":{"description":"List assets","tags":["Assets"],"parameters":[{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/SortBy"},{"$ref":"#/components/parameters/Search"},{"in":"query","name":"categories","schema":{"type":"string"},"description":"a comma-separated list of category ids to filter resulting set"},{"in":"query","name":"noCategories","schema":{"type":"string"},"description":"a true/false flag to indicate an empty list of categories"},{"in":"query","name":"showArchived","schema":{"type":"string"},"description":"a true/false flag to indicate archived assets should be added to the response. Default is 'false'"},{"in":"query","name":"showHidden","schema":{"type":"string"},"description":"a true/false flag to indicate hidden assets should be added to the response. Default is 'false'"}],"responses":{"200":{"description":"A list of assets","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Asset"},{"$ref":"#/components/schemas/ScimResourceMetadata"}]}}}}},"401":{"$ref":"#/components/responses/401"}}},"post":{"description":"Register asset","tags":["Assets"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Asset"}}}},"responses":{"201":{"$ref":"#/components/responses/201"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}}},"/assets/{assetId}":{"parameters":[{"in":"path","name":"assetId","schema":{"type":"string"},"required":true}],"get":{"description":"Get asset details","tags":["Assets"],"responses":{"200":{"description":"Asset details","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Asset"},{"$ref":"#/components/schemas/ScimResourceMetadata"}]}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}},"patch":{"description":"Update asset details","tags":["Assets"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Asset"}}}},"responses":{"204":{"description":"Ok"}}},"delete":{"description":"Archive asset","tags":["Assets"],"responses":{"204":{"$ref":"#/components/responses/204"},"401":{"$ref":"#/components/responses/401"},"403":{"description":"Forbidden. Only owner account can archive or restore assets"},"404":{"$ref":"#/components/responses/404"},"422":{"description":"Unprocessable request. Asset is already archived"}}}},"/assets/{assetId}/transfers":{"post":{"description":"Initiate asset transfer","tags":["Asset Transfers"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetTransferRequest"}}}},"parameters":[{"in":"path","name":"assetId","schema":{"type":"string"},"required":true}],"responses":{"201":{"$ref":"#/components/responses/201"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/assets/{assetId}/history":{"get":{"description":"Get asset history","tags":["Asset Transfers"],"parameters":[{"in":"path","name":"assetId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"List of asset history records","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetHistory"}}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/assets/{assetId}/holders":{"parameters":[{"in":"path","name":"assetId","schema":{"type":"string"},"required":true}],"get":{"description":"List asset holders","tags":["Asset Transfers"],"responses":{"200":{"description":"List of asset holders","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetHolder"}}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}},"post":{"description":"Deposit asset to account","tags":["Asset Transfers"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositAssetRequest"}}}},"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/assets/{assetId}/sources":{"parameters":[{"in":"path","name":"assetId","schema":{"type":"string"},"required":true}],"get":{"description":"List operations that can be used as sources for transfers of this asset","tags":["Asset Transfers"],"parameters":[{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limit"},{"name":"sortBy","in":"query","schema":{"type":"string"},"description":"Comma-separated list of fields to sort the collection by (i.e. \"status:asc,created:desc\"; if not specified, will be sorted by transfer date)","required":false},{"$ref":"#/components/parameters/Search"},{"in":"query","name":"includeNonPositive","schema":{"type":"boolean","default":false},"description":"Include operations with zero or negative available quantity when double-sourcing is allowed"},{"in":"query","name":"filter","schema":{"type":"string"},"description":"Serialized (custom format) transfer properties filter"}],"responses":{"200":{"description":"List of available operations that can serve as sources","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AvailableOperationSource"}}}},"headers":{"X-Total-Count":{"schema":{"type":"number"},"description":"Total number of records available for paging purposes"},"X-Total-Before-Filter":{"schema":{"type":"number"},"description":"Total count before applying search or filters"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/assets/{assetId}/restore":{"post":{"description":"Restore archived asset","tags":["Assets"],"parameters":[{"in":"path","name":"assetId","schema":{"type":"string"},"required":true}],"responses":{"204":{"$ref":"#/components/responses/204"},"401":{"$ref":"#/components/responses/401"},"403":{"description":"Forbidden. Only owner account can archive or restore assets"},"404":{"$ref":"#/components/responses/404"},"422":{"description":"Unprocessable request. Asset is not archived"}}}},"/assets/{assetId}/transfers/batch":{"post":{"description":"Initiate multiple asset transfers","tags":["Asset Transfers"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewMultipleTransfer"}}}},"parameters":[{"in":"path","name":"assetId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"List of asset transactions","content":{"application/json":{"schema":{"type":"object","properties":{"initiated":{"type":"number"}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/assets/categories":{"get":{"description":"List asset categories","tags":["Asset Categories"],"responses":{"200":{"description":"List of asset categories","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetCategory"}}}}},"401":{"$ref":"#/components/responses/401"}}},"post":{"description":"Create asset category","tags":["Asset Categories"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetCategory"}}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"string","description":"Created category ID"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}}},"/assets/categories/{categoryId}":{"delete":{"description":"Delete asset category","tags":["Asset Categories"],"parameters":[{"in":"path","name":"categoryId","schema":{"type":"string"},"required":true}],"responses":{"204":{"$ref":"#/components/responses/204"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/assets/shares":{"get":{"description":"List asset shares","tags":["Asset Sharing"],"responses":{"200":{"description":"List of asset and transfer shares","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetShareList"}}}},"401":{"$ref":"#/components/responses/401"}}},"post":{"description":"Create asset share","tags":["Asset Sharing"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewAssetShare"}}}},"responses":{"201":{"$ref":"#/components/responses/201"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/assets/shares/{shareId}":{"parameters":[{"in":"path","name":"shareId","schema":{"type":"string"},"required":true}],"get":{"security":[],"description":"Get asset share details","tags":["Asset Sharing"],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetShare"}}}},"404":{"$ref":"#/components/responses/404"}}},"delete":{"description":"Delete asset share","tags":["Asset Sharing"],"responses":{"204":{"$ref":"#/components/responses/204"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/assets/shares/{shareId}/transfers":{"get":{"security":[],"description":"Get shared asset history","tags":["Asset Sharing"],"parameters":[{"in":"path","name":"shareId","schema":{"type":"string"},"required":true},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/SortBy"},{"name":"since","description":"Get transfer after specific time. The value should contain a valid JavaScript Timestamp","in":"query","schema":{"type":"number"},"required":false},{"name":"till","description":"Get transfer before specific time. The value should contain a valid JavaScript Timestamp","in":"query","schema":{"type":"number"},"required":false},{"name":"sourcesGroupingMethod","in":"query","schema":{"type":"string","enum":["precise","fifo"]}}],"responses":{"200":{"description":"List of transfers between date ranges","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetShareTransfer"}}}}},"404":{"$ref":"#/components/responses/404"}}}},"/assets/shares/{shareId}/transfers/{transferId}":{"get":{"security":[],"description":"Get shared asset transfer details","tags":["Asset Sharing"],"parameters":[{"in":"path","name":"shareId","schema":{"type":"string"},"required":true},{"in":"path","name":"transferId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Transfer details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnyAssetOperation"}}}},"404":{"$ref":"#/components/responses/404"}}}},"/assets/shares/{shareId}/transfers/{transferId}/sources":{"get":{"security":[],"description":"List shared asset transfer sources","tags":["Asset Sharing"],"parameters":[{"in":"path","name":"shareId","schema":{"type":"string"},"required":true},{"in":"path","name":"transferId","schema":{"type":"string"},"required":true},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/SortBy"},{"name":"sourcesGroupingMethod","in":"query","schema":{"type":"string","enum":["precise","fifo"]}}],"responses":{"200":{"description":"List of transfers that provided an amount of asset that was transferred in given transfer","content":{"application/json":{"schema":{"type":"array","title":"Transfers","items":{"$ref":"#/components/schemas/AnyAssetOperation"}}}}},"404":{"$ref":"#/components/responses/404"}}}},"/assets/shares/{shareId}/transfers/{transferId}/form":{"get":{"security":[],"description":"Get shared asset transfer properties form","tags":["Asset Sharing"],"parameters":[{"in":"path","name":"shareId","schema":{"type":"string"},"required":true},{"in":"path","name":"transferId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Transfer properties form","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Form"}}}},"404":{"$ref":"#/components/responses/404"}}}},"/assets/transformations":{"post":{"description":"Transform asset(s) into another asset(s)","tags":["Asset Transformations"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransformAssetRequest"}}}},"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}}},"/payment-adjustments":{"get":{"description":"Get payment adjustments","tags":["Payment Adjustments"],"parameters":[{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/SortBy"},{"in":"query","name":"archived","schema":{"type":"string","enum":["1","0"]},"description":"a 1/0 flag to indicate archived payment adjustments. Default is '0'."}],"responses":{"200":{"description":"A list of payment adjustments","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PaymentAdjustmentList"}}}}},"401":{"$ref":"#/components/responses/401"}}},"post":{"description":"Register payment adjustment","tags":["Payment Adjustments"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentAdjustment"}}}},"responses":{"201":{"$ref":"#/components/responses/201"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}}},"/payment-adjustments/{paymentAdjustmentId}":{"parameters":[{"name":"paymentAdjustmentId","description":"Unique id of a payment adjustment","in":"path","schema":{"type":"string"},"required":true}],"get":{"description":"Get a payment adjustment by id","tags":["Payment Adjustments"],"responses":{"200":{"description":"Payment adjustment model","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaymentAdjustment"},{"$ref":"#/components/schemas/ScimResourceMetadata"}]}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}},"put":{"description":"Modify a payment adjustment","tags":["Payment Adjustments"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentAdjustment"}}}},"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}},"post":{"description":"Restore a payment adjustment","tags":["Payment Adjustments"],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}},"delete":{"description":"Archive a payment adjustment","tags":["Payment Adjustments"],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}}},"/transactions":{"get":{"description":"List own transactions","tags":["Asset Transactions"],"parameters":[{"$ref":"#/components/parameters/AssetCodes"},{"$ref":"#/components/parameters/TransactionKind"},{"name":"owner","in":"query","schema":{"type":"string","enum":["own","sub","any"]},"description":"Filter transactions by owner. One of [me, sub] for own and sub account transactions. If omitted, not filtered by owner"},{"name":"accountIds","in":"query","schema":{"type":"string"},"description":"Filter transactions by other party accountId. Comma-separated list"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/SortBy"}],"responses":{"200":{"description":"List of transactions","content":{"application/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Transaction"}},"codes":{"type":"array","items":{"type":"string"}},"totalCount":{"type":"number"}}}}},"headers":{"X-Total-Count":{"schema":{"type":"number"},"description":"Total number of records available for paging purposes"}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}},"post":{"description":"Initiate transaction","tags":["Asset Transactions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTransactionRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/201"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}}}},"/transactions/{transactionId}/finalize":{"post":{"description":"Process draft payments","tags":["Asset Transactions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinalizeDraftTransactionRequest"}}}},"parameters":[{"in":"path","name":"transactionId","schema":{"type":"string"},"required":true}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}}}},"/transactions/{transactionId}":{"get":{"description":"Get transaction details","tags":["Asset Transactions"],"parameters":[{"in":"path","name":"transactionId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Transaction details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeTransaction"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}},"delete":{"description":"Revert transaction","tags":["Asset Transactions"],"parameters":[{"in":"path","name":"transactionId","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevertTransaction"}}}},"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/transactions/{transactionId}/operations":{"get":{"description":"List transaction operations.","tags":["Asset Transactions"],"parameters":[{"in":"path","name":"transactionId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"List of asset operations: transfers, deposits, transformations and transformation results","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnyAssetOperation"}}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/transactions/{transactionId}/operations/{operationId}/history":{"get":{"description":"Get visible chain of custody for the requested transaction","tags":["Asset Transactions"],"parameters":[{"in":"path","name":"transactionId","schema":{"type":"string"},"required":true},{"in":"path","name":"operationId","schema":{"type":"string"},"required":true},{"in":"query","name":"timeout","schema":{"type":"number","minimum":1,"maximum":3600000}},{"in":"query","name":"format","schema":{"type":"string","enum":["xlsx"]}},{"in":"query","name":"theme","schema":{"$ref":"#/components/schemas/ExcelTableTheme"}}],"responses":{"200":{"description":"List of asset operations: transfers, deposits, transformations and transformation results","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChainedOperation"}}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/transactions/{transactionId}/operations/{operationId}/history/schema":{"get":{"description":"Get JSON schema for operations from chain of custody for the requested transaction","tags":["Asset Transactions"],"parameters":[{"in":"path","name":"transactionId","schema":{"type":"string"},"required":true},{"in":"path","name":"operationId","schema":{"type":"string"},"required":true},{"in":"query","name":"format","schema":{"type":"string","enum":["xlsx"]}}],"responses":{"200":{"description":"JSON schema","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonSchema"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/transactions/{transactionId}/history":{"get":{"description":"Get visible chain of custody for the requested transaction","tags":["Asset Transactions"],"parameters":[{"in":"path","name":"transactionId","schema":{"type":"string"},"required":true},{"in":"query","name":"timeout","schema":{"type":"number","minimum":1,"maximum":3600000}},{"in":"query","name":"format","schema":{"type":"string","enum":["xlsx"]}}],"responses":{"200":{"description":"List of asset operations: transfers, deposits, transformations and transformation results","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChainedOperation"}}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/transactions/{transactionId}/history/schema":{"get":{"description":"Get JSON schema for operations of chain of custody for the requested transaction","tags":["Asset Transactions"],"parameters":[{"in":"path","name":"transactionId","schema":{"type":"string"},"required":true},{"in":"query","name":"format","schema":{"type":"string","enum":["xlsx"]}}],"responses":{"200":{"description":"JSON schema","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonSchema"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/transactions/batch":{"post":{"description":"Initiate batch transaction","tags":["Asset Transactions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBatchTransactionRequest"}}}},"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}}}},"/transfers":{"get":{"description":"List asset transfers","tags":["Asset Transfers"],"parameters":[{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/SortBy"},{"name":"owner","in":"query","schema":{"type":"string","enum":["own","sub","any"]},"description":"Filter transfers by owner. One of [me, sub] for own and sub account transfers. If omitted, not filtered by owner"},{"name":"assetId","in":"query","description":"Filter transfers by one `assetId`. Cannot be specified together with `assetIds` param","schema":{"type":"string"},"required":false},{"name":"assetIds","description":"Filter transfers by one or multiple `assetId`'s. Multiple assetId values should be separated by commas. Cannot be specified together with `assetId` param","in":"query","schema":{"type":"string"},"required":false},{"name":"since","description":"Get transfer after specific time. The value should contain a valid JavaScript Timestamp","in":"query","schema":{"type":"number"},"required":false},{"name":"till","description":"Get transfer before specific time. The value should contain a valid JavaScript Timestamp","in":"query","schema":{"type":"number"},"required":false},{"name":"accountIds","description":"Filter transfers by one or multiple `accountId`'s. Multiple accountId values should be separated by commas","in":"query","schema":{"type":"string"},"required":false},{"name":"includeReverted","description":"Include reverted transfers in output. Defaults to `false`","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"sourcesGroupingMethod","in":"query","schema":{"type":"string","enum":["precise","fifo"]}},{"$ref":"#/components/parameters/AssetCodes"},{"$ref":"#/components/parameters/TransactionKind"}],"responses":{"200":{"description":"List of account transfers","content":{"application/json":{"schema":{"type":"array","title":"Transfers","items":{"$ref":"#/components/schemas/AnyAssetOperation"}}}},"headers":{"X-Total-Count":{"schema":{"type":"number"},"description":"Total number of records available for paging purposes"}}},"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/transfers/{transferId}":{"get":{"description":"Get asset operation by id in own account","tags":["Asset Transfers"],"parameters":[{"name":"transferId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Asset operation details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnyAssetOperation"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/transfers/{transferId}/sources":{"get":{"description":"List asset transfer sources","tags":["Asset Transfers"],"parameters":[{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/SortBy"},{"name":"participantsType","in":"query","schema":{"type":"string","enum":["all","last"],"default":"all"},"required":false},{"name":"transferId","in":"path","schema":{"type":"string"},"required":true},{"name":"sourcesGroupingMethod","in":"query","schema":{"type":"string","enum":["precise","fifo"]}}],"responses":{"200":{"description":"List of transfers that provided an amount of asset that was transferred in given transfer","content":{"application/json":{"schema":{"type":"array","title":"Transfers","items":{"$ref":"#/components/schemas/AnyAssetOperation"}}}},"headers":{"X-Total-Count":{"schema":{"type":"number"},"description":"Total number of records available for paging purposes"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/transfers/{transferId}/confirmReceipt":{"post":{"description":"Confirm transfer receiving","tags":["Asset Transfers"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmTransferReceipt"}}}},"parameters":[{"in":"path","name":"transferId","schema":{"type":"string"},"required":true}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/transfers/{transferId}/rejectReceipt":{"post":{"description":"Reject transfer receiving","tags":["Asset Transfers"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectTransferReceipt"}}}},"parameters":[{"in":"path","name":"transferId","schema":{"type":"string"},"required":true}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/transfers/{transferId}/resendClaimToken":{"post":{"description":"Resend claim token for pending transfer","tags":["Asset Transfers"],"parameters":[{"in":"path","name":"transferId","schema":{"type":"string"},"required":true}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"}}}},"/agent/transfers/incomplete/claim":{"post":{"description":"Re-issue transfer claim token","tags":["Asset Transfer Claiming"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"identificationNumber":{"type":"string"},"email":{"type":"string"},"phoneNumber":{"type":"string"}}}}}},"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ClaimedTransfer"},{"type":"object","properties":{"claimToken":{"type":"string"}}}]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/agent/transfers/{claimToken}/claim":{"post":{"description":"Issue transfer finalization token. Requires at least two input parameters: claim token and at least one of ids of receiver","tags":["Asset Transfer Claiming"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"identificationNumber":{"type":"string"},"email":{"type":"string"},"phoneNumber":{"type":"string"}}}}}},"parameters":[{"in":"path","name":"claimToken","schema":{"type":"string"},"required":true}],"responses":{"204":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimedTransfer"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/agent/transfers/{claimToken}/finalize":{"post":{"description":"Finalize transfer","tags":["Asset Transfer Claiming"],"parameters":[{"in":"path","name":"claimToken","schema":{"type":"string"},"required":true}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}}}},"/forms":{"get":{"description":"List forms","tags":["Forms"],"parameters":[{"name":"status","in":"query","schema":{"type":"string","enum":["own","shared","archived"]},"required":false}],"responses":{"200":{"description":"All forms available in a current account, including ones shared from connected accounts","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/FormDto"},{"$ref":"#/components/schemas/ScimResourceMetadata"}]}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}},"post":{"description":"Create form","tags":["Forms"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Form"}}}},"responses":{"201":{"$ref":"#/components/responses/201"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}}}},"/forms/{formId}":{"get":{"description":"Get form details","tags":["Forms"],"parameters":[{"name":"formId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Form"},{"$ref":"#/components/schemas/ScimResourceMetadata"}]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}},"patch":{"description":"Modify form","tags":["Forms"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Form"}}},"required":true},"parameters":[{"name":"formId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"204":{"$ref":"#/components/responses/204"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}},"delete":{"description":"Archive form","tags":["Forms"],"parameters":[{"name":"formId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"204":{"$ref":"#/components/responses/204"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}},"/forms/fragments":{"get":{"description":"List available form fragments","tags":["Forms"],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/FormDto"},{"$ref":"#/components/schemas/ScimResourceMetadata"}]}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}}},"/forms/{formId}/editable":{"get":{"description":"Get not composed form details for editing. Includes fragment references rather than their fields","tags":["Forms"],"parameters":[{"name":"formId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Form"},{"$ref":"#/components/schemas/ScimResourceMetadata"}]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}}},"/forms/{formId}/restore":{"post":{"description":"Restore archived form","tags":["Forms"],"parameters":[{"name":"formId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"204":{"$ref":"#/components/responses/204"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"}}}},"/forms/{formId}/assign":{"post":{"description":"Request form data entry from connected identity","tags":["Forms"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"assigneeId":{"type":"string","description":"ID of a connected User or Org"}},"required":["assigneeId"]}}}},"parameters":[{"name":"formId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"201":{"$ref":"#/components/responses/201"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}},"/forms/{formId}/data-entries":{"get":{"description":"List form data entries","tags":["Form Data Entries"],"parameters":[{"$ref":"#/components/parameters/formIdOrAll"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/SortBy"},{"$ref":"#/components/parameters/Search"},{"name":"status","in":"query","schema":{"type":"string","enum":["all","pending","submitted","reviewed","rejected","approved","denied","archived"]},"description":"Data entry status filter. One or more statuses separated by comma.","required":false}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FormDataEntry"}}}}},"401":{"$ref":"#/components/responses/401"}}},"post":{"description":"Create form data entry","tags":["Form Data Entries"],"parameters":[{"$ref":"#/components/parameters/formIdOrAll"},{"$ref":"#/components/parameters/preventNotify"},{"name":"submitAfterCreation","in":"query","schema":{"type":"boolean"},"required":false,"description":"If `true` the data entry will be submitted after it's created"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormData"}}}},"responses":{"201":{"$ref":"#/components/responses/201"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}}}},"/forms/{formId}/data-entries/{entryId}":{"get":{"description":"Get form data entry data","tags":["Form Data Entries"],"parameters":[{"$ref":"#/components/parameters/formIdOrAll"},{"$ref":"#/components/parameters/entryIdOrPrimaryKey"}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormData"}}}},"400":{"$ref":"#/components/responses/400"}}},"patch":{"description":"Modify form data entry","tags":["Form Data Entries"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormData"}}}},"parameters":[{"name":"lastModified","in":"query","schema":{"type":"number"},"required":false},{"name":"allowDuplicates","in":"query","schema":{"type":"string","enum":["true","false"]},"required":false},{"$ref":"#/components/parameters/formIdOrAll"},{"$ref":"#/components/parameters/entryIdOrPrimaryKey"},{"$ref":"#/components/parameters/preventNotify"}],"responses":{"200":{"description":"HTTP 200 - OK. Request is valid but result of patch is no-op. Content of response contains a message about this effect"},"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"}}},"delete":{"description":"Archive form data entry","tags":["Form Data Entries"],"parameters":[{"$ref":"#/components/parameters/formIdOrAll"},{"$ref":"#/components/parameters/entryIdOrPrimaryKey"},{"$ref":"#/components/parameters/preventNotify"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}},"/forms/{formId}/data-entries/{entryId}/duplicate":{"post":{"description":"Duplicate existing data entry","tags":["Form Data Entries"],"parameters":[{"$ref":"#/components/parameters/formIdOrAll"},{"$ref":"#/components/parameters/entryIdOrPrimaryKey"},{"$ref":"#/components/parameters/preventNotify"}],"responses":{"201":{"$ref":"#/components/responses/201"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}},"/forms/{formId}/data-entries/{entryId}/submit":{"post":{"description":"Submit data entry to form owner","tags":["Form Data Entries"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormData"}}}},"parameters":[{"name":"lastModified","in":"query","schema":{"type":"number"},"required":false},{"$ref":"#/components/parameters/formIdOrAll"},{"$ref":"#/components/parameters/entryIdOrPrimaryKey"},{"$ref":"#/components/parameters/preventNotify"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}},"/forms/{formId}/data-entries/{entryId}/review":{"post":{"description":"Mark submitted data entry as reviewed","tags":["Form Data Entries"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewDataEntry"}}}},"parameters":[{"$ref":"#/components/parameters/formIdOrAll"},{"$ref":"#/components/parameters/entryIdOrPrimaryKey"},{"$ref":"#/components/parameters/preventNotify"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"}}}},"/forms/{formId}/data-entries/{entryId}/withdraw":{"post":{"description":"Withdraw the submitted data entry","tags":["Form Data Entries"],"parameters":[{"$ref":"#/components/parameters/formIdOrAll"},{"$ref":"#/components/parameters/entryIdOrPrimaryKey"},{"$ref":"#/components/parameters/preventNotify"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"}}}},"/forms/{formId}/data-entries/{entryId}/responders":{"post":{"description":"Add data entry responders","tags":["Form Data Entries"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddFormDataResponders"}}}},"parameters":[{"$ref":"#/components/parameters/formIdOrAll"},{"$ref":"#/components/parameters/entryIdOrPrimaryKey"},{"$ref":"#/components/parameters/preventNotify"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"}}},"put":{"description":"Replace data entry responders","tags":["Form Data Entries"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceFormDataResponders"}}}},"parameters":[{"$ref":"#/components/parameters/formIdOrAll"},{"$ref":"#/components/parameters/entryIdOrPrimaryKey"},{"$ref":"#/components/parameters/preventNotify"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"}}}},"/forms/{formId}/data-entries/{entryId}/responders/{responderId}":{"delete":{"description":"Remove a responder from the data entry by Id","tags":["Form Data Entries"],"parameters":[{"$ref":"#/components/parameters/formIdOrAll"},{"$ref":"#/components/parameters/entryIdOrPrimaryKey"},{"name":"responderId","in":"path","schema":{"$ref":"#/components/schemas/Id"},"required":true,"description":"Responder Id"},{"$ref":"#/components/parameters/preventNotify"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}},"/forms/{formId}/data-entries/{entryId}/reject":{"post":{"description":"Reject submitted form data entry back to editor","tags":["Form Data Entries"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFormData"}}}},"parameters":[{"$ref":"#/components/parameters/formIdOrAll"},{"$ref":"#/components/parameters/entryIdOrPrimaryKey"},{"$ref":"#/components/parameters/preventNotify"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}},"/forms/{formId}/data-entries/{entryId}/approval":{"post":{"description":"Mark submitted data entry as approved","tags":["Form Data Entries"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApproveDataEntry"}}}},"parameters":[{"$ref":"#/components/parameters/formIdOrAll"},{"$ref":"#/components/parameters/entryIdOrPrimaryKey"},{"$ref":"#/components/parameters/preventNotify"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}},"delete":{"description":"Revoke approval of a form data entry","tags":["Form Data Entries"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevokeDataEntryApproval"}}}},"parameters":[{"$ref":"#/components/parameters/formIdOrAll"},{"$ref":"#/components/parameters/entryIdOrPrimaryKey"},{"$ref":"#/components/parameters/preventNotify"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}},"/forms/{formId}/data-entries/{entryId}/denial":{"post":{"description":"Deny form data entry, which means no more re-submissions will be allowed (aka permanent reject)","tags":["Form Data Entries"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DenyDataEntry"}}}},"parameters":[{"$ref":"#/components/parameters/formIdOrAll"},{"$ref":"#/components/parameters/entryIdOrPrimaryKey"},{"$ref":"#/components/parameters/preventNotify"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}},"delete":{"description":"Revoke denial of a form data entry","tags":["Form Data Entries"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevokeDataEntryDenial"}}}},"parameters":[{"$ref":"#/components/parameters/formIdOrAll"},{"$ref":"#/components/parameters/entryIdOrPrimaryKey"},{"$ref":"#/components/parameters/preventNotify"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}},"/forms/{formId}/data-entries/{entryId}/restore":{"post":{"description":"Restore data entry that was previously archived","tags":["Form Data Entries"],"parameters":[{"$ref":"#/components/parameters/formIdOrAll"},{"$ref":"#/components/parameters/entryIdOrPrimaryKey"},{"$ref":"#/components/parameters/preventNotify"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}},"/smart-contracts":{"get":{"description":"List smart contracts","tags":["Smart Contracts"],"responses":{"200":{"description":"list of account's smart contracts","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/SmartContract"},{"type":"object","properties":{"description":{"type":"string"}}},{"$ref":"#/components/schemas/ScimResourceMetadata"}]}}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}}},"post":{"description":"Create smart contract","tags":["Smart Contracts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartContract"}}}},"responses":{"201":{"$ref":"#/components/responses/201"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}}}},"/smart-contracts/{contractId}":{"parameters":[{"name":"contractId","description":"Smart contract identifier","in":"path","schema":{"type":"string"},"required":true}],"get":{"description":"Get smart contract details","tags":["Smart Contracts"],"responses":{"200":{"description":"Smart contract details","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SmartContract"},{"$ref":"#/components/schemas/ScimResourceMetadata"}]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}},"put":{"description":"Update smart contract","tags":["Smart Contracts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartContract"}}}},"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"422":{"$ref":"#/components/responses/422"}}},"delete":{"description":"Deactivate smart contract","tags":["Smart Contracts"],"responses":{"204":{"$ref":"#/components/responses/204"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"422":{"$ref":"#/components/responses/422"}}}},"/smart-contracts/{contractId}/history":{"parameters":[{"name":"contractId","description":"Smart contract identifier","in":"path","schema":{"type":"string"},"required":true}],"get":{"description":"Get smart contract execution history","tags":["Smart Contracts"],"responses":{"200":{"description":"Smart contract execution history","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"state":{"type":"string","enum":["running","canceled","complete","failed"]},"steps":{"type":"array","items":{"type":"object","properties":{"at":{"$ref":"#/components/schemas/Timestamp"},"type":{"type":"string","enum":["running","canceled","complete","failed"]},"message":{"type":"string"}},"additionalProperties":false,"required":["at","type"]}}},"additionalProperties":false,"required":["id","state","steps"]}}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}},"/smart-contracts/{contractId}/restore":{"parameters":[{"name":"contractId","description":"Smart contract identifier","in":"path","schema":{"type":"string"},"required":true}],"post":{"description":"Reactivate smart contract","tags":["Smart Contracts"],"responses":{"204":{"$ref":"#/components/responses/204"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"422":{"$ref":"#/components/responses/422"}}}},"/smart-contracts/triggers":{"get":{"description":"Get available triggers","tags":["Smart Contracts"],"responses":{"200":{"description":"List of available triggers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmartContractTrigger"}}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}}}},"/smart-contracts/triggers/{triggerId}":{"parameters":[{"name":"triggerId","description":"Trigger identifier","in":"path","schema":{"type":"string"},"required":true}],"get":{"description":"Get trigger details","tags":["Smart Contracts"],"responses":{"200":{"description":"Trigger details","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SmartContractTrigger"},{"type":"object","properties":{"schema":{"$ref":"#/components/schemas/JsonSchema"},"sample":{"type":"object","additionalProperties":true},"authenticationRequired":{"description":"Indicates if the trigger is being invoked in a different account context and a smart contract authentication token is required","type":"boolean"}},"additionalProperties":false}]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}}}},"/smart-contracts/actions":{"get":{"description":"List available actions","tags":["Smart Contracts"],"parameters":[{"name":"type","description":"Optional Action type filter","in":"query","schema":{"type":"string","enum":["read","write"]}}],"responses":{"200":{"description":"List of actions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartContractAction"}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}}}},"/smart-contracts/actions/{actionId}":{"parameters":[{"name":"actionId","description":"Smart contract action identifier","in":"path","schema":{"type":"string"},"required":true}],"get":{"description":"Get smart contract action details","tags":["Smart Contracts"],"responses":{"200":{"description":"Smart contract action details","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SmartContractAction"},{"type":"object","properties":{"schema":{"$ref":"#/components/schemas/JsonSchema"},"sample":{"type":"object","additionalProperties":true},"mappingTemplate":{"$ref":"#/components/schemas/Mapping"}},"additionalProperties":false}]}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}}}},"/data-processors":{"get":{"description":"List data processors","tags":["Data Processors"],"responses":{"200":{"description":"list of account's data processors","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/DataProcessor"},{"$ref":"#/components/schemas/ScimResourceMetadata"}]}}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}}},"post":{"description":"Create data processor","tags":["Data Processors"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataProcessor"}}}},"responses":{"201":{"$ref":"#/components/responses/201"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}}}},"/data-processors/{processorId}":{"parameters":[{"name":"processorId","description":"Data processor identifier","in":"path","schema":{"type":"string"},"required":true}],"get":{"description":"Get data processor details","tags":["Data Processors"],"responses":{"200":{"description":"Data processor details","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/DataProcessor"},{"$ref":"#/components/schemas/ScimResourceMetadata"}]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}},"put":{"description":"Update data processor","tags":["Data Processors"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataProcessor"}}}},"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"422":{"$ref":"#/components/responses/422"}}},"delete":{"description":"Archive data processor","tags":["Data Processors"],"responses":{"204":{"$ref":"#/components/responses/204"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"422":{"$ref":"#/components/responses/422"}}}},"/data-processors/{processorId}/restore":{"parameters":[{"name":"processorId","description":"Data processor identifier","in":"path","schema":{"type":"string"},"required":true}],"post":{"description":"Restore data processor","tags":["Data Processors"],"responses":{"204":{"$ref":"#/components/responses/204"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"422":{"$ref":"#/components/responses/422"}}}},"/data-processors/{processorId}/validate":{"parameters":[{"name":"processorId","description":"Data processor identifier","in":"path","schema":{"type":"string"},"required":true}],"post":{"description":"Validate file","tags":["Data Processors"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"s3FileKey":{"type":"string","description":"Amazon S3 File Key"}},"additionalProperties":false,"required":["s3FileKey"]}}}},"responses":{"200":{"description":"Validation Result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataProcessorResult"}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"422":{"$ref":"#/components/responses/422"}}}},"/data-processors/{processorId}/process":{"parameters":[{"name":"processorId","description":"Data processor identifier","in":"path","schema":{"type":"string"},"required":true}],"post":{"description":"Import and process file","tags":["Data Processors"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"s3FileKey":{"type":"string","description":"Amazon S3 File Key"},"offset":{"type":"number","description":"The input offset"}},"additionalProperties":false,"required":["s3FileKey"]}}}},"responses":{"200":{"description":"Validation Result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataProcessorResult"}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"422":{"$ref":"#/components/responses/422"}}}},"/data-processors/{processorId}/stop":{"parameters":[{"name":"processorId","description":"Data processor identifier","in":"path","schema":{"type":"string"},"required":true}],"post":{"description":"Stop processing file","tags":["Data Processors"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"s3FileKey":{"type":"string","description":"Amazon S3 File Key"}},"additionalProperties":false,"required":["s3FileKey"]}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"stopped":{"type":"boolean"}}}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"422":{"$ref":"#/components/responses/422"}}}},"/validation-workflows":{"get":{"description":"List validation workflows","tags":["Validation Workflows"],"responses":{"200":{"description":"list of account's validation workflows","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ValidationWorkflowSummary"},{"type":"object","properties":{"description":{"type":"string"}}},{"$ref":"#/components/schemas/ScimResourceMetadata"}]}}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}}},"post":{"description":"Create validation workflow","tags":["Validation Workflows"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationWorkflowDetails"}}}},"responses":{"201":{"$ref":"#/components/responses/201"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}}}},"/validation-workflows/{workflowId}":{"parameters":[{"name":"workflowId","description":"Validation workflow identifier","in":"path","schema":{"type":"string"},"required":true}],"get":{"description":"Get validation workflow details","tags":["Validation Workflows"],"responses":{"200":{"description":"Validation workflow details","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ValidationWorkflowDetails"},{"$ref":"#/components/schemas/ScimResourceMetadata"}]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}},"put":{"description":"Update validation workflow","tags":["Validation Workflows"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationWorkflowDetails"}}}},"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"422":{"$ref":"#/components/responses/422"}}},"delete":{"description":"Deactivate validation workflow","tags":["Validation Workflows"],"responses":{"204":{"$ref":"#/components/responses/204"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"422":{"$ref":"#/components/responses/422"}}}},"/validation-workflows/{workflowId}/restore":{"parameters":[{"name":"workflowId","description":"Validation workflow identifier","in":"path","schema":{"type":"string"},"required":true}],"post":{"description":"Reactivate validation workflow","tags":["Validation Workflows"],"responses":{"204":{"$ref":"#/components/responses/204"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"422":{"$ref":"#/components/responses/422"}}}},"/aws/upload-url":{"get":{"tags":["Attachments"],"description":"Pre-signed URL","parameters":[{"name":"contentType","description":"type of content for file that is going to be uploaded","in":"query","schema":{"type":"string"},"required":true},{"name":"fileName","description":"fileName","in":"query","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"reSignedUrl Target url to upload user file","content":{"application/json":{"schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/401"}}}},"/notifications":{"get":{"security":[],"description":"Get User Notifications","tags":["Notifications"],"responses":{"200":{"description":"Notifications","content":{"application/json":{"schema":{"type":"object","properties":{"pendingShareRequests":{"type":"object","properties":{"approved":{"type":"boolean"},"photo":{"type":"string"},"expiresAt":{"type":"integer"},"id":{"type":"string"},"isReceiverOrg":{"type":"boolean"},"isSenderOrg":{"type":"boolean"},"name":{"type":"string"},"sections":{"type":"array","items":{"type":"string"}}}}}}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}}}},"/tutorials":{"get":{"description":"List tutorials","tags":["Tutorials"],"parameters":[{"name":"invalidate","in":"query","schema":{"type":"string"},"description":"Passing any value will invalidate internal cache. Fresh data will be requested from tutorials definitions source."}],"responses":{"200":{"description":"List of available tutorials","content":{"application/json":{"schema":{"type":"array","items":{"properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/LocalizedString"},"permissions":{"type":"array","items":{"type":"array","items":{"type":"string"},"minItems":2,"maxItems":2}},"view":{"type":"array","items":{"type":"string"},"uniqueItems":true},"autoStart":{"type":"boolean"},"environments":{"type":"array","items":{"type":"string"},"uniqueItems":true},"organizations":{"type":"array","items":{"type":"string"},"uniqueItems":true},"steps":{"type":"array","items":{"$ref":"#/components/schemas/TutorialStep"}},"priority":{"type":"number"}}}}}}}}}}},"tags":[{"name":"Authentication"},{"name":"User Profile"},{"name":"User Profile Sharing"},{"name":"Connections","description":"Connected organizations and identitites"},{"name":"Public Profiles"},{"name":"Organizations","description":"Organization accounts"},{"name":"Organization Associates"},{"name":"Organization Roles","description":"Organization Roles and Permissions"},{"name":"Organization Features"},{"name":"Assets"},{"name":"Asset Categories"},{"name":"Asset Transactions","description":"Asset exchange/buy/sell transactions that consist of multiple asset transfers"},{"name":"Asset Transfers","description":"Asset transfers from one owner to another"},{"name":"Asset Transfer Claiming"},{"name":"Asset Transformations"},{"name":"Asset Sharing"},{"name":"Payment Adjustments","description":"Adjustments of payments on buy/sell transactions"},{"name":"Forms"},{"name":"Form Data Entries","description":"Form assignments and submitted form data entries"},{"name":"Attachments"},{"name":"Smart Contracts","description":"Automation workflows that react to system events"},{"name":"Data Processors","description":"Automation workflows for custom formats import"},{"name":"Validation Workflows","description":"Automation workflows for custom validations on any write API actions"},{"name":"Tutorials","description":"Interactive system guides"},{"name":"Notifications"}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Your authentication token"}},"parameters":{"Offset":{"name":"offset","in":"query","schema":{"type":"number","minimum":0,"default":0},"description":"0-based index of the first element","required":false},"Limit":{"name":"limit","in":"query","schema":{"type":"number","default":20,"minimum":1},"description":"Number or items per page","required":false},"AssetCodes":{"name":"codes","in":"query","schema":{"type":"string"},"description":"Comma-separated list of codes to filter transactions. If omitted, not filtered by code","required":false},"TransactionKind":{"name":"transactionKind","in":"query","schema":{"type":"string","enum":["buy","sell","transfer","deposit","transformation","draft-locked","draft-unlocked"]},"required":false},"SortBy":{"name":"sortBy","in":"query","schema":{"type":"string"},"description":"Comma-separated list of fields to sort the collection by (i.e. \"status:asc,created:desc\")","required":false},"Search":{"name":"search","in":"query","schema":{"type":"string"},"description":"A space-separated list of keywords to search items by","required":false},"connectionId":{"name":"connectionId","description":"Connection identifier (userId, orgId, inviteId, verified email, verified phoneNumber, userName, or externalId)","in":"path","schema":{"type":"string"},"required":true},"formIdOrAll":{"name":"formId","in":"path","schema":{"type":"string"},"required":true,"description":"Parent form ID, can be set to \"all\""},"entryIdOrPrimaryKey":{"name":"entryId","in":"path","schema":{"type":"string"},"description":"BQ Id of the entry or double-pipe-separated (||) list of globally primary field values. Order is the same as fields appear on UI. FormId cannot be \"all\" for such request.","example":"value1||value 2||value-3","required":true},"preventNotify":{"name":"preventNotify","in":"query","schema":{"type":"boolean"},"required":false,"description":"If truthy, the notifications triggered by the endpoint will be suppressed"}},"schemas":{"Resource":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string","uniqueItems":true},"readOnly":true},"id":{"type":"string","description":"The resource type's server unique id","readOnly":true},"externalId":{"type":"string","description":"A String that is an identifier for the resource as defined by the provisioning client. The \"externalId\" may simplify identification of a resource between the provisioning client and the service provider by allowing the client to use a filter to locate the resource with an identifier from the provisioning domain, obviating the need to store a local mapping between the provisioning domain's identifier of the resource and the identifier used by the service provider."},"meta":{"type":"object","description":"A complex attribute containing resource metadata. All \"meta\" sub-attributes are assigned by the service provider (have a \"mutability\" of \"readOnly\"), and all of these sub-attributes have a \"returned\" characteristic of \"default\".","properties":{"resourceType":{"type":"string","enum":["User","Org","Invite"],"readOnly":true},"created":{"type":"number","readOnly":true},"lastModified":{"type":"number","readOnly":true},"location":{"type":"string","format":"uri","readOnly":true}},"readOnly":true}}},"Id":{"title":"Id","type":"string","minLength":32,"maxLength":32,"example":"00000000000000000000000000000000"},"ImmutableId":{"type":"string","readOnly":true,"minLength":32,"maxLength":32,"example":"00000000000000000000000000000000"},"Timestamp":{"type":"number","description":"Number of milliseconds elapsed since January 1, 1970 00:00:00 UTC","example":1568894551000},"ImmutableTimestamp":{"type":"number","readOnly":true,"description":"Number of milliseconds elapsed since January 1, 1970 00:00:00 UTC","example":1568894551000},"LocalizedString":{"type":"object","required":["en"],"additionalProperties":{"type":"string","description":"Strings in different languages"},"properties":{"en":{"type":"string","description":"Default English localization string"}}},"OptionalLocalizedString":{"type":"object","additionalProperties":{"type":"string","description":"Strings in different languages"}},"DateTime":{"type":"string","format":"date-time"},"EffectiveDate":{"allOf":[{"$ref":"#/components/schemas/DateTime"},{"title":"Effective Transfer Date","description":"The effective date and time of the transfer in ISO format with timezone defined."}]},"GeoCoordinates":{"type":"object","properties":{"lat":{"type":"number","format":"double","minimum":-90,"maximum":90},"lon":{"type":"number","format":"double","minimum":-180,"maximum":180}},"additionalProperties":false,"required":["lat","lon"],"example":{"lat":37.7749,"lon":-122.4194}},"EffectiveLocation":{"allOf":[{"$ref":"#/components/schemas/GeoCoordinates"},{"title":"Effective Transfer Geo Location","description":"The effective location coordinates of a transfer instead of an automatically determined"}]},"ScimResourceMetadata":{"type":"object","readOnly":true,"properties":{"displayName":{"type":"string","readOnly":true},"meta":{"type":"object","properties":{"resourceType":{"type":"string","readOnly":true},"created":{"type":"number","readOnly":true},"lastModified":{"type":"number","readOnly":true}},"required":["resourceType","created","lastModified"]}},"required":["displayName","meta"]},"SignUpWithToken":{"type":"object","properties":{"email":{"type":"string","format":"email"},"password":{"type":"string","minLength":8,"maxLength":32},"name":{"$ref":"#/components/schemas/PersonName"},"phoneNumber":{"type":"string"}},"anyOf":[{"title":"SignUp with phone number","type":"object","required":["phoneNumber","password","name"],"example":{"phoneNumber":"0123456789","name":{"givenName":"John","familyName":"Doe"},"password":"pa$$w0rd"}},{"title":"SignUp with email","type":"object","required":["email","password","name"],"example":{"email":"example@email.com","name":{"givenName":"John","familyName":"Doe"},"password":"pa$$w0rd"}}],"additionalProperties":false},"SignUp":{"type":"object","properties":{"email":{"type":"string","format":"email"},"password":{"type":"string","minLength":8,"maxLength":32},"phoneNumber":{"type":"string"},"name":{"$ref":"#/components/schemas/PersonName"},"orgToken":{"type":"string"}},"anyOf":[{"title":"SignUp with phone number","type":"object","required":["phoneNumber","password","name"],"example":{"phoneNumber":"0123456789","name":{"givenName":"John","familyName":"Doe"},"password":"pa$$w0rd"}},{"title":"SignUp with email","type":"object","required":["email","password","name"],"example":{"email":"example@email.com","name":{"givenName":"John","familyName":"Doe"},"password":"pa$$w0rd"}}],"additionalProperties":false},"AuthInfo":{"type":"object","properties":{"token":{"type":"string","readOnly":true},"refreshToken":{"type":"string","readOnly":true},"permissions":{"$ref":"#/components/schemas/Permissions"},"permissionsOverConnections":{"$ref":"#/components/schemas/Permissions"},"readOnly":{"type":"boolean","readOnly":true}}},"Permissions":{"type":"object","additionalProperties":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["create","read","update","delete"]}}},"InviteInfo":{"type":"object","properties":{"phoneNumber":{"type":"string"},"email":{"type":"string"},"givenName":{"type":"string"},"familyName":{"type":"string"},"isEmailInvite":{"type":"boolean"},"isPhoneInvite":{"type":"boolean"}}},"ApiTokenInfo":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"title":{"type":"string","minLength":1},"created":{"$ref":"#/components/schemas/ImmutableTimestamp"},"expires":{"$ref":"#/components/schemas/ImmutableTimestamp"}},"required":["title"]},"ApiTokenCreationParameters":{"allOf":[{"$ref":"#/components/schemas/ApiTokenInfo"},{"type":"object","properties":{"password":{"type":"string","description":"Current user's password"}},"required":["password"]}]},"AccountInfo":{"type":"object","properties":{"id":{"description":"Unique account ID","type":"string","minLength":32,"maxLength":32,"readOnly":true},"displayName":{"description":"Human-readable account name","type":"string","readOnly":true},"logo":{"description":"URL of a primary account photo or logo","type":"string","format":"url","readOnly":true},"isOrg":{"description":"Indicates if account is an Org account","type":"boolean","readOnly":true}}},"PersonName":{"type":"object","properties":{"givenName":{"$ref":"#/components/schemas/PersonNameField"},"familyName":{"$ref":"#/components/schemas/PersonNameField"}},"required":["givenName","familyName"],"additionalProperties":false},"PersonNameField":{"type":"string","minLength":1,"maxLength":100,"pattern":"^\\p{L}+(?:[ '-]\\p{L}+)*$"},"AuthTokens":{"description":"Auth and refresh tokens for API request authentication","properties":{"token":{"type":"string","description":"Token that needs to be provided in the X-BQ-Token header of auth-protected API requests"},"tokenExpires":{"type":"integer","readOnly":true},"refreshToken":{"type":"string"},"refreshTokenExpires":{"type":"integer","readOnly":true}},"required":["token","refreshToken"]},"ExistentProfile":{"allOf":[{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ImmutableId"}}},{"$ref":"#/components/schemas/Profile"}],"unevaluatedProperties":false},"CreateUserRequest":{"allOf":[{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/ProfileRequirements"}],"unevaluatedProperties":false},"Profile":{"title":"User Profile","type":"object","properties":{"displayName":{"type":"string","description":"The name of the user, suitable for displaying to other parties","readOnly":true},"name":{"title":"Structured User Name","allOf":[{"type":"object","additionalProperties":false,"properties":{"formatted":{"type":"string","description":"The full name, including all middle names, titles, and suffixes as appropriate, formatted for display","example":"Ms. Barbara Jane Jensen, III"},"honorificPrefix":{"type":"string","description":"The honorific prefix(es) of the User, or title in most Western languages.","example":"Ms."},"givenName":{"type":"string","description":"The given name of the User, or first name in most Western languages.","example":"Barbara"},"middleName":{"type":"string","description":"The middle name(s) of the User.","example":"Jane"},"familyName":{"type":"string","description":"The family name of the User, or last name in most Western languages.","example":"Jensen"},"honorificSuffix":{"type":"string","description":"The honorific suffix(es) of the User, or suffix in most Western languages.","example":"III"}}},{"anyOf":[{"title":"formatted name not empty","required":["formatted"]},{"title":"givenName and familyName not empty","required":["givenName","familyName"]}]}]},"userName":{"type":"string","minLength":5,"maxLength":50,"pattern":"^[a-zA-Z]{2}\\w+$","description":"A unique, manually-set identifier for the user in BanQu system (requires additional account permissions to be used)"},"emails":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/ProfileEmail"}},"phoneNumbers":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/ProfilePhoneNumber"}},"ims":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/ProfileProperty"}},"photos":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/ProfilePhoto"}},"addresses":{"type":"array","uniqueItems":true,"items":{"type":"object","description":"A physical mailing address for this user","additionalProperties":false,"properties":{"type":{"type":"string","description":"Canonical type values of \"work\", \"home\", and \"other\"","example":"home"},"formatted":{"type":"string","description":"The full mailing address, formatted for display or use with a mailing label"},"streetAddress":{"type":"string","description":"The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information."},"locality":{"type":"string","description":"The city or locality component"},"region":{"type":"string","description":"The state or region component"},"postalCode":{"type":"string","description":"The zipcode or postal code component"},"country":{"type":"string","description":"The country name component. When specified the value MUST be in ISO 3166-1 alpha 2 \"short\" code format [ISO3166]","example":"US"}}}},"preferredLanguage":{"type":"string","description":"Indicates the user's preferred written or spoken languages and is generally used for selecting a localized User interface. The value indicates the set of natural languages that are preferred.","example":"en"},"locale":{"type":"string","enum":["en-us","en-gb","en-za","uk-ua"],"description":"Used to indicate the User's default location for purposes of localizing such items as currency, date time format, or numerical representations. A valid value is a language tag as defined in [RFC5646](https://tools.ietf.org/html/rfc5646). Computer languages are explicitly excluded."},"urn:banqu:schemas:scim:User:social":{"title":"User social profile","type":"object","properties":{"gender":{"type":"string","enum":["","O","M","F"],"example":"M","description":"Letter of a gender: \"M\" for male, \"F\" for female, \"O\" for other, or empty value not to specify it"},"birthday":{"type":"string","format":"date","example":"1985-04-17"}}},"urn:banqu:schemas:scim:User:identification":{"title":"User identification documents","type":"array","uniqueItems":true,"items":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","minLength":1},"$entityId":{"type":"string","minLength":1},"country":{"type":"string","description":"The country name component. When specified the value MUST be in ISO 3166-1 alpha 2 \"short\" code format [ISO3166]","example":"US","minLength":2,"maxLength":2},"expiresOn":{"type":"string","format":"date"},"issuedBy":{"type":"string"},"issuedOn":{"type":"string","format":"date"},"id":{"type":"string","minLength":1},"attachments":{"$ref":"#/components/schemas/Attachment"}},"required":["type","id"]}}},"patternProperties":{"^urn:banqu:schemas:([a-f\\d]{32}|scim):User:[a-zA-Z_][\\da-zA-Z_]*$":{"anyOf":[{"type":"object"},{"type":"array"}]}}},"ProfileProperty":{"title":"Profile Property","type":"object","properties":{"type":{"type":"string"},"value":{"type":"string","minLength":1},"primary":{"type":"boolean"}},"required":["value"]},"ProfileEmail":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/ProfileProperty"},{"properties":{"value":{"type":"string","format":"email","example":"user@example.com"}}}]},{"type":"string","format":"email","minLength":1,"example":"user@example.com"}]},"PhoneNumber":{"description":"Phone Number with Country Prefix","type":"string","pattern":"^(?:(?:\\+|00 ?|011 ?|010 ?|0011 ?)?(1|20|212|213|216|218|220|221|222|223|224|225|226|227|228|229|230|231|232|233|234|235|236|237|238|239|240|241|242|243|244|245|248|249|250|251|252|253|254|255|256|257|258|260|261|262|263|264|265|266|267|269|27|290|291|297|298|299|30|31|32|33|34|350|351|352|353|354|355|356|357|358|359|36|370|371|372|373|374|375|376|377|378|380|381|382|385|386|387|389|39|40|41|420|421|423|43|44|45|46|47|48|49|500|501|502|503|504|505|506|507|508|509|51|52|53|54|55|56|57|58|590|591|592|593|594|595|596|597|598|60|61|62|63|64|65|66|670|672|673|674|675|676|677|678|679|680|681|682|683|685|686|687|688|689|690|691|692|7|81|82|84|852|853|855|856|86|880|886|90|91|92|93|94|95|960|961|962|963|964|965|966|967|968|970|971|972|973|974|975|976|977|98|992|993|994|995|996|998))((?:\\)?[ -.]?\\(?\\d){6,11})$","example":"+1 555 999 8877"},"ProfilePhoneNumber":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/ProfileProperty"},{"properties":{"value":{"$ref":"#/components/schemas/PhoneNumber"}}}]},{"$ref":"#/components/schemas/PhoneNumber"}]},"ProfilePhoto":{"allOf":[{"$ref":"#/components/schemas/ProfileProperty"},{"properties":{"etag":{"type":"string","minLength":32,"maxLength":32,"example":"00000000000000000000000000000000"},"value":{"type":"string","format":"url","example":"https://example.com/avatar.jpg"}}}]},"ProfileRequirements":{"title":"Profile with email, phoneNumber, identification document, or name and birthday","anyOf":[{"title":"emails not empty","properties":{"emails":{"minItems":1}},"required":["emails"]},{"title":"phoneNumbers not empty","properties":{"phoneNumbers":{"minItems":1}},"required":["phoneNumbers"]},{"title":"identification documents not empty","properties":{"urn:banqu:schemas:scim:User:identification":{"minItems":1}},"required":["urn:banqu:schemas:scim:User:identification"]},{"title":"name and birthday not empty","properties":{"urn:banqu:schemas:scim:User:social":{"required":["birthday"]}},"required":["name","urn:banqu:schemas:scim:User:social"]},{"title":"name and userName not empty","required":["name","userName"]}]},"ProfileVisibility":{"type":"object","properties":{"publicEnabled":{"type":"boolean","description":"Should the profile be visible from Internet"},"publicSections":{"type":"array","description":"Profile sections visible to Internet","items":{"type":"string","uniqueItems":true}},"connectionsEnabled":{"type":"boolean","description":"Should the profile be visible for Connections"},"connectionsSections":{"type":"array","description":"Profile sections visible to Connections","items":{"type":"string","uniqueItems":true}}},"required":["publicEnabled","publicSections","connectionsEnabled","connectionsSections"]},"ProfileSection":{"type":"object","properties":{"formId":{"$ref":"#/components/schemas/Id"},"title":{"type":"string"},"name":{"type":"string"},"priority":{"type":"number","description":"Defines order of profile sections. Standard sections are numbered 100, 200, 300, etc."}}},"ProfileSectionsList":{"type":"array","items":{"$ref":"#/components/schemas/ProfileSection"}},"ProfileShareRequests":{"type":"object","description":"User profile data","properties":{"approved":{"type":"boolean"},"expiresAt":{"type":"number"},"id":{"type":"string"},"isReceiverOrg":{"type":"boolean"},"isSenderOrg":{"type":"boolean"},"name":{"type":"string"},"photo":{"type":"string"},"sections":{"type":"array","items":{"type":"string"}}}},"PackagedShareProfileListItem":{"type":"object","description":"Packaged share profile data","properties":{"assets":{"type":"array","items":{"type":"string"}},"bucket":{"type":"string"},"connections":{"type":"string"},"createdAt":{"type":"integer"},"expiresAt":{"type":"integer"},"ownerId":{"type":"string"},"sections":{"type":"array","items":{"type":"string"}},"state":{"type":"string"}}},"NewPackagedShareProfile":{"type":"object","properties":{"sections":{"type":"array","items":{"type":"string"}},"expiresAt":{"type":"integer"},"sectionConfigurations":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"PackagedShareProfile":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"streetAddress":{"type":"string"}}}},"displayName":{"type":"string"},"emails":{"type":"array","items":{"type":"object","properties":{"primary":{"type":"boolean"},"type":{"type":"string"},"value":{"type":"string"}}}},"meta":{"type":"object","properties":{"created":{"type":"integer"},"lastModified":{"type":"integer"},"resourceType":{"type":"string"}}},"name":{"type":"object","properties":{"familyName":{"type":"string"},"formatted":{"type":"string"},"givenName":{"type":"string"}}},"photos":{"type":"array","items":{"type":"object","properties":{"etag":{"type":"string"},"primary":{"type":"boolean"},"value":{"type":"string"}}}}},"additionalProperties":{"type":"string"}},"SharedTransformationOperation":{"type":"object","properties":{"id":{"type":"string"},"transactionId":{"type":"string"},"code":{"$ref":"#/components/schemas/AssetCode"},"description":{"$ref":"#/components/schemas/AssetDescription"},"uom":{"$ref":"#/components/schemas/AssetUom"},"type":{"type":"string","enum":["transformation","transformation-result"]},"sources":{"type":"array","items":{"$ref":"#/components/schemas/SharedTransformationAsset"}},"destinations":{"type":"array","items":{"$ref":"#/components/schemas/SharedTransformationAsset"}},"qty":{"type":"number"},"sent":{"type":"number"},"creator":{"$ref":"#/components/schemas/TransactionParty"}},"required":["id","transactionId","uom","code","type","sources","destinations","qty","sent","creator"]},"SharedTradeOperation":{"type":"object","properties":{"id":{"type":"string"},"transactionId":{"type":"string"},"direction":{"type":"string","enum":["in","out"]},"received":{"type":"number"},"code":{"$ref":"#/components/schemas/AssetCode"},"description":{"$ref":"#/components/schemas/AssetDescription"},"uom":{"$ref":"#/components/schemas/AssetUom"},"isCredit":{"type":"boolean"},"type":{"type":"string","enum":["transfer"]},"qty":{"type":"number"},"sent":{"type":"number"},"receiver":{"$ref":"#/components/schemas/TransactionParty"},"sender":{"$ref":"#/components/schemas/TransactionParty"},"paymentStatus":{"type":"string","enum":["pending","complete","rejected"]}},"required":["id","transactionId","direction","received","uom","code","isCredit","type","qty","sent","receiver","sender"]},"SharedOperation":{"allOf":[{"$ref":"#/components/schemas/SharedTransformationOperation"},{"$ref":"#/components/schemas/SharedTradeOperation"}]},"SharedOperations":{"type":"array","items":{"$ref":"#/components/schemas/SharedOperation"}},"SharedTransactionStats":{"type":"object","properties":{"incomingPending":{"type":"string"},"outgoingPending":{"type":"string"}}},"SharedDeposit":{"type":"object","properties":{"assetId":{"type":"string"},"code":{"$ref":"#/components/schemas/AssetCode"},"description":{"$ref":"#/components/schemas/AssetDescription"},"uom":{"$ref":"#/components/schemas/AssetUom"},"creator":{"$ref":"#/components/schemas/TransactionParty"},"creatorId":{"type":"string"},"creatorUser":{"$ref":"#/components/schemas/TransactionParty"},"creatorUserId":{"type":"string"},"holder":{"$ref":"#/components/schemas/TransactionParty"},"holderId":{"type":"string"},"id":{"type":"string"},"qty":{"type":"number","minimum":0},"sent":{"type":"number"},"type":{"type":"string","enum":["deposit"]}},"required":["id","type","sent","assetId","code","uom","creator","creatorId","creatorUser","creatorUserId","holder","holderId","qty"]},"SharedTransformationAsset":{"type":"object","properties":{"id":{"type":"string"},"code":{"$ref":"#/components/schemas/AssetCode"},"description":{"$ref":"#/components/schemas/AssetDescription"},"uom":{"$ref":"#/components/schemas/AssetUom"}},"required":["id","uom","code"]},"SharedTransformation":{"type":"object","properties":{"id":{"type":"string"},"transactionId":{"type":"string"},"type":{"type":"string","enum":["transformation"]},"sent":{"type":"number"},"creatorId":{"type":"string"},"creator":{"$ref":"#/components/schemas/TransactionParty"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/SharedTransformationAsset"}},"destinations":{"type":"array","items":{"$ref":"#/components/schemas/SharedTransformationAsset"}}},"required":["id","transactionId","type","sent","creatorId","creator","sources","destinations"]},"SharedTradeTransaction":{"type":"object","properties":{"id":{"type":"string"},"transactionId":{"type":"string"},"type":{"type":"string","enum":["trade"]},"isCredit":{"type":"boolean"},"receiver":{"$ref":"#/components/schemas/TransactionParty"},"sender":{"$ref":"#/components/schemas/TransactionParty"},"stats":{"$ref":"#/components/schemas/SharedTransactionStats"},"sent":{"type":"number"},"transfers":{"type":"array","items":{"type":"string"}},"participants":{"type":"array","items":{"type":"string"}}},"required":["id","transactionId","type","isCredit","receiver","sender","sent","transfers","participants"]},"SharedTransfer":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Id"},"code":{"$ref":"#/components/schemas/AssetCode"},"description":{"$ref":"#/components/schemas/AssetDescription"},"uom":{"$ref":"#/components/schemas/AssetUom"},"direction":{"type":"string","enum":["in","out"]},"received":{"type":"number"},"isCredit":{"type":"boolean"},"type":{"type":"string","enum":["transfer"]},"qty":{"type":"number"},"sent":{"type":"number"},"assetId":{"type":"string"},"sender":{"$ref":"#/components/schemas/TransactionParty"},"receiver":{"$ref":"#/components/schemas/TransactionParty"}},"required":["id","direction","received","uom","code","isCredit","type","qty","sent","assetId","sender","receiver"]},"SharedBatchTransaction":{"type":"object","properties":{"id":{"type":"string"},"transactionId":{"type":"string"},"isCredit":{"type":"boolean"},"type":{"type":"string","enum":["batch"]},"sent":{"type":"number"},"sender":{"$ref":"#/components/schemas/TransactionParty"},"receiver":{"$ref":"#/components/schemas/TransactionParty"},"transfers":{"type":"array","items":{"type":"string"}},"stats":{"$ref":"#/components/schemas/SharedTransactionStats"}},"required":["id","transactionId","isCredit","type","sent","sender","receiver","transfers","stats"]},"SharedTransaction":{"oneOf":[{"$ref":"#/components/schemas/SharedDeposit"},{"$ref":"#/components/schemas/SharedTransformation"},{"$ref":"#/components/schemas/SharedTradeTransaction"},{"$ref":"#/components/schemas/SharedTransfer"},{"$ref":"#/components/schemas/SharedBatchTransaction"}]},"ShareRequest":{"type":"object","description":"A share request","properties":{"approved":{"type":"boolean"},"isSenderOrg":{"type":"boolean"},"isReceiverOrg":{"type":"boolean"},"sections":{"type":"array","items":{"type":"string"},"uniqueItems":true}}},"ShallowProfile":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Id"},"displayName":{"type":"string"},"name":{"type":"object"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/ProfileProperty"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/ProfileProperty"}},"photos":{"type":"array","items":{"$ref":"#/components/schemas/ProfileProperty"}}},"required":["id"]},"GeoJsonFeatureCollection":{"type":"object","properties":{"type":{"type":"string","enum":["FeatureCollection"]},"features":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["Feature"]},"geometry":{"$ref":"#/components/schemas/GeoJsonGeometryObject"},"properties":{"type":"object"}},"required":["type","geometry"]}}},"required":["type","features"]},"GeoJsonGeometryObject":{"type":"object","properties":{"type":{"type":"string","enum":["Point","MultiPoint","LineString","MultiLineString","Polygon","MultiPolygon","GeometryCollection"]},"coordinates":{"oneOf":[{"type":"array","items":{"type":"number","minItems":2}},{"type":"array","items":{"type":"array","items":{"type":"number","minItems":2}}},{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"number","minItems":2}}}}]}},"required":["type","coordinates"]},"PrivateLabeling":{"type":"object","properties":{"logoUrl":{"type":"string"}}},"License":{"type":"object","properties":{"orgId":{"type":"string","description":"License is assigned at enterprise level. If requested orgId is a child org this parameter will contain orgId of the enterprise"},"adminsLimit":{"type":"number","minimum":0,"description":"all new roles assigned will be checked whether they have admin privilege level permissions if it turns a user from 'regular' to 'admin' the user may be counted as a one more admin within licenseProvider read further to understand conditions when a new admin is counted"},"unique":{"type":"boolean","description":"when false, counts every org associate with admin privileges in every suborg. When true, only counts unique users, for ex., owner of enterprise will not be counted as admin in suborgs"},"limitPer":{"type":"string","enum":["suborg","enterprise"],"description":"makes the adminsLimit work for the sum off all admins across the enterprise or in each org separately"},"adminsAvailableInAccount":{"type":"number","description":"contains how many admin slots left in current org for suborg license or if requested orgId is enterprise root"}},"required":["orgId","adminsLimit","unique","limitPer"]},"LocalizedName":{"allOf":[{"$ref":"#/components/schemas/LocalizedString"},{"properties":{"en":{"minLength":2,"maxLength":20}},"additionalProperties":{"minLength":2,"maxLength":20}}]},"LocalizedDescription":{"allOf":[{"$ref":"#/components/schemas/LocalizedString"},{"properties":{"en":{"maxLength":80}},"additionalProperties":{"maxLength":80}}]},"UserOrg":{"description":"Org account user participates in","properties":{"id":{"type":"string","readOnly":true},"name":{"type":"string","minLength":2},"photos":{"type":"array","items":{"$ref":"#/components/schemas/ProfileProperty"}},"roles":{"type":"array","description":"Roles of the current user in the org account","readOnly":true,"items":{"type":"string"}},"active":{"type":"boolean","readOnly":true}}},"Org":{"type":"object","description":"Organization Account","properties":{"id":{"type":"string","readOnly":true},"displayName":{"type":"string","readOnly":true},"name":{"type":"string","minLength":3,"maxLength":100},"emails":{"type":"array","items":{"$ref":"#/components/schemas/ProfileProperty"}},"photos":{"type":"array","items":{"$ref":"#/components/schemas/ProfileProperty"}},"documents":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["user-agreement","associate-agreement"]},"title":{"type":"string"},"url":{"type":"string","format":"url"}},"required":["type","title","url"]}},"active":{"type":"boolean","readOnly":true},"users":{"type":"array","readOnly":true,"description":"List of users participating in the Org account","items":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"roles":{"type":"array","readOnly":true,"items":{"type":"string"}}}}},"urn:banqu:schemas:scim:Org:notifications":{"type":"object","properties":{"whatsappOptedIn":{"type":"boolean"}}}},"additionalProperties":true},"OrgAssociateRoles":{"title":"Role IDs","description":"ID's of the roles assigned to the associate in the current org account","type":"array","uniqueItems":true,"items":{"title":"Role ID","type":"string","minLength":1}},"OrgAssociate":{"type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/ImmutableId"},"name":{"type":"string"},"email":{"type":"string","format":"email"},"phoneNumber":{"type":"string"},"photo":{"type":"string","format":"url","readOnly":true},"roles":{"$ref":"#/components/schemas/OrgAssociateRoles"}},"required":["name"]},"OrgAssociateInvite":{"allOf":[{"type":"object","additionalProperties":false,"properties":{"inviteId":{"$ref":"#/components/schemas/ImmutableId"},"expires":{"$ref":"#/components/schemas/ImmutableTimestamp"},"name":{"type":"string"},"email":{"type":"string","format":"email"},"phoneNumber":{"type":"string"},"roles":{"$ref":"#/components/schemas/OrgAssociateRoles"}},"required":["name"]},{"anyOf":[{"title":"email not empty","required":["email"]},{"title":"phoneNumber not empty","required":["phoneNumber"]}]}]},"OrgAssociatePatch":{"type":"object","additionalProperties":false,"properties":{"roles":{"$ref":"#/components/schemas/OrgAssociateRoles"}},"required":["roles"]},"OrgRole":{"type":"object","description":"Organization role","properties":{"id":{"type":"string","readOnly":true},"name":{"$ref":"#/components/schemas/LocalizedName"},"description":{"$ref":"#/components/schemas/LocalizedDescription"},"permissions":{"$ref":"#/components/schemas/OrgCapabilities"},"predefined":{"type":"boolean","description":"Indicates that role is defined by system and is immutable"},"shared":{"type":"boolean","description":"Indicates that role is not owned by current org but is shared from a connected one"},"type":{"type":"string","description":"Defines on which entity the role can be applied","enum":["associate","connection"]},"ownerDisplayName":{"type":"string"},"ownerId":{"type":"string"}},"required":["name","description","permissions","type"]},"EditableOrgRole":{"type":"object","description":"Organization role","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/LocalizedName"},"type":{"type":"string","enum":["associate","connection"]},"description":{"$ref":"#/components/schemas/LocalizedDescription"},"permissions":{"type":"object","additionalProperties":{"type":"array","uniqueItems":true,"items":{"type":"string"}}},"ownerId":{"type":"string","maxLength":32}},"additionalProperties":false},"OrgCapabilities":{"type":"object","description":"Capabilities of organization account","additionalProperties":{"type":"array","items":{"type":"string","enum":["create","read","update","delete"]},"uniqueItems":true}},"OrgFeatures":{"type":"object","description":"Features of organization account","additionalProperties":{"type":"object","properties":{"description":{"type":"string"},"resources":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","enum":["create","read","update","delete"]},"uniqueItems":true}}}}},"ConnectionFilter":{"type":"object","properties":{"criteria":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","enum":["=",">","<","!=","in","notIn","contains"]},"formId":{"description":"Id of user or org profile form","type":"string"},"name":{"description":"Field JSON name. For multiple sections format is sectionName[].fieldName","type":"string"},"value":{"description":"type: string, number, boolean, array<string> value that should be compared against in specified field of found profiles","anyOf":[{"type":"object"},{"type":"string"},{"type":"number"},{"type":"boolean"}]}},"required":["action","formId","name","value"]}},"match":{"type":"string","enum":["any","all"]}},"required":["filter","match"]},"Connection":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"$ref":"#/components/schemas/Profile"},{"$ref":"#/components/schemas/ConnectionExtension"}],"required":["id"]},"ConnectionExtension":{"type":"object","properties":{"urn:banqu:schemas:extensions:connection":{"type":"object","properties":{"pending":{"type":"boolean","description":"Indicates if connection is still waiting for an acceptance","readOnly":true},"direction":{"type":"string","description":"Indicates what side initiated a connection","enum":["in","out"],"readOnly":true},"assignedAssociates":{"type":"array","description":"A list of Org Associate ID's responsible for this connection","items":{"type":"string","minLength":32,"maxLength":32,"uniqueItems":true}}}}}},"ConnectionCreatePayload":{"allOf":[{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/Id"},{"description":"Id of the user in the BanQu system"}]},"assignedAssociates":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/Id"}},"forceCreation":{"type":"boolean","description":"Create user or connection automatically (requires additional account permissions to be used)","default":false},"preventNotify":{"type":"boolean","description":"Suppress SMS notifications","default":false}}},{"$ref":"#/components/schemas/Profile"},{"anyOf":[{"title":"Profile with Id","required":["id"]},{"$ref":"#/components/schemas/ProfileRequirements"}]}],"example":{"name":{"formatted":"John Doe"},"emails":[{"value":"john@example.com"}],"preferredLanguage":"en","locale":"en-us","externalId":"id-in-external-system","assignedAssociates":[]}},"ConnectionProfileUpdatePayload":{"allOf":[{"$ref":"#/components/schemas/ExistentProfile"},{"type":"object","properties":{"preventNotify":{"type":"boolean","description":"Suppress SMS notifications","default":false},"lastModified":{"type":"number"}}}]},"AssetCategory":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/AssetCode"},"description":{"$ref":"#/components/schemas/AssetDescription"},"uom":{"$ref":"#/components/schemas/AssetUom"}},"required":["code"]},"Asset":{"type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/ImmutableId"},"ownerId":{"$ref":"#/components/schemas/Id"},"creatorId":{"$ref":"#/components/schemas/ImmutableId"},"code":{"$ref":"#/components/schemas/AssetCode"},"description":{"$ref":"#/components/schemas/AssetDescription"},"uom":{"$ref":"#/components/schemas/AssetUom"},"attachments":{"$ref":"#/components/schemas/Attachments"},"isCredit":{"type":"boolean","default":false,"description":"Indicates whether the asset will be used as a normal resource or as a credit balance"},"qty":{"type":"number","default":0,"writeOnly":true},"minQty":{"type":"number"},"balance":{"type":"number","readOnly":true},"confirmedBalance":{"type":"number","readOnly":true},"rejectedAmount":{"type":"number","readOnly":true},"archived":{"type":"boolean","readOnly":true},"transferPropertiesForm":{"$ref":"#/components/schemas/Form"},"prices":{"$ref":"#/components/schemas/AssetPrices"},"allowOtherCurrencies":{"type":"boolean","description":"Indicates if currencies other than listed in `prices` can be used in transactions","default":false},"requireExplicitSources":{"description":"Indicates if explicit transfer sources must be specified for every transfer","type":"boolean","default":false},"autoFilterProperties":{"description":"Indicates if automatic filtering by matching properties should occur when selecting sources or sellers","type":"boolean","default":false},"allowDoubleSourcing":{"description":"Indicates that operations of this asset can be used as sources multiple times without tracing availability","type":"boolean","default":false},"usagePreferences":{"$ref":"#/components/schemas/AssetUsagePreferences"},"confirmationPropagationMode":{"type":"string","enum":["none","proportional","scot-free"]}},"required":["code","uom","qty"]},"AssetCode":{"type":"string","minLength":2,"maxLength":32},"AssetUom":{"title":"Asset Unit of Measurement","type":"string","enum":["BR","BO","BX","BU","CN","CA","CH","DO","EA","FO","FT","GA","GR","HR","JA","KG","KK","LT","Q3","MR","MG","M4","OZ","PK","PR","PC","LB","SJ","VS","YD"],"example":"KG"},"AssetDescription":{"type":"string","minLength":0,"maxLength":200},"AssetHolder":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ImmutableId"},"balance":{"type":"number"},"displayName":{"type":"string"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/ProfileProperty"}},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/ProfileProperty"}},"photos":{"type":"array","items":{"$ref":"#/components/schemas/ProfileProperty"}},"isOrg":{"type":"boolean"}}},"AssetPrices":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Unique asset price identifier (used for price sharing)"},"title":{"type":"string"},"fixed":{"type":"boolean","description":"Can the price be edited during buy/sell transaction"},"amount":{"type":"number","minimum":0},"currency":{"type":"string","minLength":3,"maxLength":3},"min":{"type":"number","minimum":0},"max":{"type":"number","minimum":0}},"required":["id","amount","currency"]}},"DepositAssetRequest":{"type":"object","properties":{"holderId":{"$ref":"#/components/schemas/Id"},"qty":{"type":"number","minimum":0,"exclusiveMinimum":true},"message":{"type":"string"},"effectiveDate":{"$ref":"#/components/schemas/EffectiveDate"},"effectiveLocation":{"$ref":"#/components/schemas/EffectiveLocation"}},"additionalProperties":false,"required":["holderId","qty"]},"TransformAssetRequest":{"type":"object","properties":{"sources":{"type":"array","description":"Asset(s) that are being transformed","minItems":1,"items":{"type":"object","properties":{"assetId":{"$ref":"#/components/schemas/Id"},"quantity":{"type":"number","minimum":0,"exclusiveMinimum":true},"sourceOperations":{"$ref":"#/components/schemas/SourceOperations"},"effectiveDate":{"$ref":"#/components/schemas/EffectiveDate"},"effectiveLocation":{"$ref":"#/components/schemas/EffectiveLocation"}},"additionalProperties":false,"required":["assetId","quantity"]}},"destinations":{"type":"array","description":"Asset(s) that are being created in result of the transformation","minItems":1,"items":{"type":"object","properties":{"assetId":{"$ref":"#/components/schemas/Id"},"quantity":{"type":"number","minimum":0,"exclusiveMinimum":true},"effectiveDate":{"$ref":"#/components/schemas/EffectiveDate"},"effectiveLocation":{"$ref":"#/components/schemas/EffectiveLocation"}},"additionalProperties":false,"required":["assetId","quantity"]}},"properties":{"type":"object","properties":{"$formId":{"type":"string"}},"additionalProperties":true,"required":["$formId"]}},"additionalProperties":false,"required":["sources","destinations"]},"TransactionParty":{"type":"object","readOnly":true,"properties":{"id":{"$ref":"#/components/schemas/ImmutableId"},"name":{"type":"string","readOnly":true},"photoUrl":{"type":"string","format":"url","readOnly":true},"photoEtag":{"type":"string","readOnly":true},"isOrg":{"type":"boolean"}}},"AssetTransferRequest":{"type":"object","properties":{"receiverId":{"$ref":"#/components/schemas/Id"},"destinationProvider":{"$ref":"#/components/schemas/PaymentDestinationProvider"},"destinationId":{"$ref":"#/components/schemas/PaymentDestinationId"},"destinationType":{"$ref":"#/components/schemas/PaymentDestinationType"},"qty":{"type":"number","minimum":0,"exclusiveMinimum":true},"sourceOperations":{"$ref":"#/components/schemas/SourceOperations"},"properties":{"type":"object"},"message":{"type":"string"},"effectiveDate":{"$ref":"#/components/schemas/EffectiveDate"},"effectiveLocation":{"$ref":"#/components/schemas/EffectiveLocation"}},"required":["receiverId","qty"],"additionalProperties":false},"NewMultipleTransfer":{"type":"array","items":{"type":"object","properties":{"qty":{"type":"number","minimum":0,"exclusiveMinimum":true},"receiver":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Id"},"email":{"type":"string"},"phoneNumber":{"type":"string"}},"additionalProperties":false},"destinationProvider":{"$ref":"#/components/schemas/PaymentDestinationProvider"},"destinationId":{"title":"Agency ID for BanQu agency or nothing for any BanQu agency or MTN phone number","type":"string"},"properties":{"type":"object"},"message":{"type":"string"},"preventNotify":{"type":"boolean"},"effectiveDate":{"$ref":"#/components/schemas/EffectiveDate"},"effectiveLocation":{"$ref":"#/components/schemas/EffectiveLocation"}},"required":["receiver","qty"],"additionalProperties":false}},"Attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}},"Attachment":{"type":"object","additionalProperties":false,"properties":{"downloadUrl":{"type":"string","format":"url"},"fileName":{"type":"string","minLength":1},"fileSize":{"type":"number","minimum":0},"mimeType":{"type":"string","minLength":1,"example":"image/jpeg"},"md5":{"type":"string","minLength":32,"maxLength":32,"pattern":"^[a-f0-9]{32}$"}},"required":["downloadUrl"]},"NewAssetShare":{"type":"object","properties":{"assetId":{"$ref":"#/components/schemas/Id"},"transferId":{"$ref":"#/components/schemas/Id"},"startDate":{"$ref":"#/components/schemas/Timestamp"},"endDate":{"$ref":"#/components/schemas/Timestamp"},"since":{"$ref":"#/components/schemas/Timestamp"},"till":{"$ref":"#/components/schemas/Timestamp"}},"required":["assetId"]},"AvailableOperationSource":{"type":"object","description":"Operation that can be reused as a source for another asset transfer","properties":{"id":{"$ref":"#/components/schemas/ImmutableId"},"type":{"type":"string","enum":["transfer","deposit","transformation-result"]},"qty":{"type":"number","description":"Total quantity of the source operation"},"availableQty":{"type":"number","description":"Quantity that remains available to be used as a source"},"uom":{"$ref":"#/components/schemas/AssetUom"},"code":{"$ref":"#/components/schemas/AssetCode"},"sent":{"type":"number","description":"Timestamp when the source operation was initiated"},"location":{"$ref":"#/components/schemas/GeoCoordinates"},"message":{"type":"string"},"transactionId":{"$ref":"#/components/schemas/Id"},"sender":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ImmutableId"},"name":{"type":"string"},"isOrg":{"type":"boolean"}}},"senderUser":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ImmutableId"},"name":{"type":"string"}}},"properties":{"type":"object","description":"Additional transfer properties captured on the source operation"},"propertiesPreviewFields":{"type":"array","description":"Resolved preview fields for transfer properties","items":{"type":"object"}}},"required":["id","type","qty","availableQty","sent"]},"AssetHistory":{"type":"array","items":{"type":"object","properties":{"initialBalance":{"type":"number"},"totalQty":{"type":"number"},"transfers":{"type":"array","items":{"type":"string"}},"startTime":{"$ref":"#/components/schemas/Timestamp"},"endTime":{"$ref":"#/components/schemas/Timestamp"}}}},"SharedAsset":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Id"},"code":{"$ref":"#/components/schemas/AssetCode"},"description":{"$ref":"#/components/schemas/AssetDescription"},"uom":{"$ref":"#/components/schemas/AssetUom"},"isCredit":{"type":"boolean"},"balance":{"type":"number"}},"required":["uom","isCredit","id","code","balance"]},"SharedAssets":{"type":"array","description":"List of shared assets","items":{"$ref":"#/components/schemas/SharedAsset"}},"AssetUsagePreferences":{"type":"object","additionalProperties":false,"properties":{"buy":{"type":"boolean"},"sell":{"type":"boolean"},"send":{"type":"boolean"},"receive":{"type":"boolean"},"batch":{"type":"boolean"}}},"AssetShareList":{"type":"array","items":{"$ref":"#/components/schemas/AssetShareRow"}},"AssetShareRow":{"allOf":[{"$ref":"#/components/schemas/AssetShareDetail"},{"$ref":"#/components/schemas/AssetTransferShareDetail"}]},"AssetShareDetail":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Id"},"assetId":{"$ref":"#/components/schemas/Id"},"holderId":{"$ref":"#/components/schemas/Id"},"startDate":{"type":"string"},"endDate":{"type":"string"},"asset":{"$ref":"#/components/schemas/AssetInfo"}},"required":["id","assetId","holderId","asset"]},"AssetTransferShareDetail":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Id"},"assetId":{"$ref":"#/components/schemas/Id"},"transferId":{"$ref":"#/components/schemas/Id"},"holderId":{"$ref":"#/components/schemas/Id"},"asset":{"$ref":"#/components/schemas/AssetInfo"},"since":{"type":"integer"},"till":{"type":"integer"},"transfer":{"$ref":"#/components/schemas/AssetShareTransfer"}}},"AssetShareData":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Id"},"assetId":{"$ref":"#/components/schemas/Id"},"holderId":{"$ref":"#/components/schemas/Id"},"startDate":{"type":"string"},"endDate":{"type":"string"},"asset":{"$ref":"#/components/schemas/AssetInfo"}},"required":["assetId","id","holderId","asset"]},"AssetTransferShareData":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Id"},"assetId":{"$ref":"#/components/schemas/Id"},"transferId":{"$ref":"#/components/schemas/Id"},"holderId":{"$ref":"#/components/schemas/Id"},"since":{"$ref":"#/components/schemas/Timestamp"},"till":{"$ref":"#/components/schemas/Timestamp"},"asset":{"$ref":"#/components/schemas/AssetInfo"},"assetHistory":{"$ref":"#/components/schemas/AssetHistory"}},"required":["assetId","id","holderId","asset","since","till"]},"AssetShare":{"allOf":[{"$ref":"#/components/schemas/AssetShareData"},{"$ref":"#/components/schemas/AssetTransferShareData"}]},"AssetInfo":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Id"},"balance":{"type":"number"},"code":{"$ref":"#/components/schemas/AssetCode"},"description":{"$ref":"#/components/schemas/AssetDescription"},"uom":{"$ref":"#/components/schemas/AssetUom"},"isCredit":{"type":"boolean"},"minQty":{"type":"number"},"createdAt":{"type":"integer"},"archivedAt":{"type":"integer"},"restoredAt":{"type":"integer"},"transferPropertiesForm":{"type":"object","additionalProperties":true},"ownerId":{"type":"string"},"attachments":{"$ref":"#/components/schemas/Attachments"}},"required":["uom","isCredit","code","minQty","createdAt","id","balance"]},"AssetShareTransfer":{"type":"object","properties":{"receivedQty":{"type":"number"},"sender":{"title":"Sender","type":"object","properties":{"id":{"title":"Sender ID","type":"string","minLength":32,"maxLength":32,"example":"00000000000000000000000000000000"},"name":{"title":"Sender Name","type":"string"},"isOrg":{"title":"Sender is Org","type":"boolean"}}},"properties":{"type":"object","title":"Transfer Properties","description":"Key-value pairs with custom transfer properties","additionalProperties":true,"example":{"poNumber":"000001","stockCode":"7b35e21b717844"}},"destinations":{"type":"array","description":"Deposited assets","items":{"$ref":"#/components/schemas/TransformingAsset"}},"receiver":{"type":"object","title":"Receiver","properties":{"id":{"title":"Receiver ID","type":"string","minLength":32,"maxLength":32,"example":"00000000000000000000000000000000"},"name":{"title":"Receiver Name","type":"string"},"isOrg":{"title":"Receiver is Org","type":"boolean"},"photoUrl":{"title":"Receiver Photo","type":"string","format":"url"},"photoEtag":{"title":"Receiver Photo ETag","type":"string"}}},"receiverComment":{"type":"string"},"creator":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ImmutableId"},"name":{"type":"string"}}},"holder":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ImmutableId"},"name":{"type":"string"}}},"id":{"allOf":[{"title":"Transfer ID"},{"$ref":"#/components/schemas/Id"}]},"direction":{"title":"Transfer Direction","type":"string","enum":["in","out"]},"code":{"title":"Asset Code","type":"string"},"qty":{"title":"Quantity","type":"number","example":1},"uom":{"$ref":"#/components/schemas/AssetUom"},"description":{"title":"Asset Description","type":"string"},"sent":{"$ref":"#/components/schemas/ImmutableTimestamp"},"received":{"$ref":"#/components/schemas/ImmutableTimestamp"},"price":{"title":"Price","type":"number"},"priceCurrency":{"title":"Price Currency","type":"string","minLength":3,"maxLength":3,"example":"USD"},"destination":{"$ref":"#/components/schemas/PaymentDestination"}}},"AssetTransformationTransaction":{"type":"object","description":"Asset Transformation","additionalProperties":false,"properties":{"sources":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/TransformingAsset"}},"destinations":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/TransformingAsset"}},"creator":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ImmutableId"},"name":{"type":"string"}}},"id":{"type":"string"},"transactionId":{"type":"string"},"sent":{"type":"number"},"allCodes":{"type":"array","items":{"type":"string"}},"assetIds":{"type":"array","items":{"type":"string"}}},"required":["destinations","sources","creator","id","transactionId","sent"]},"AssetTransformationOperation":{"type":"object","description":"Operation that indicates asset(s) transformation into an arbitrary amount of some different asset(s)","properties":{"id":{"$ref":"#/components/schemas/Id"},"transactionId":{"$ref":"#/components/schemas/Id"},"assetId":{"$ref":"#/components/schemas/Id"},"code":{"$ref":"#/components/schemas/AssetCode"},"description":{"$ref":"#/components/schemas/AssetDescription"},"uom":{"$ref":"#/components/schemas/AssetUom"},"sources":{"type":"array","description":"Transformed assets. For each transformed asset there is a separate operation within the transaction. This list always includes asset transformed by this operation","items":{"$ref":"#/components/schemas/TransformingAsset"}},"destinations":{"type":"array","description":"Resulting assets. This list always includes resulting asset from this operation","items":{"$ref":"#/components/schemas/TransformingAsset"}},"direction":{"type":"string"},"qty":{"type":"number","minimum":0},"sent":{"type":"number"},"sourceOperations":{"$ref":"#/components/schemas/SourceOperations"},"sourcesCount":{"$ref":"#/components/schemas/SourcesCount"},"creator":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ImmutableId"},"name":{"type":"string"}}},"creatorUser":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ImmutableId"},"name":{"type":"string"}}},"holder":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ImmutableId"},"name":{"type":"string"}}}},"required":["id","transactionId","assetId","code","uom","destinations","direction","qty","sent"]},"TransformingAsset":{"type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/Id"},"code":{"$ref":"#/components/schemas/AssetCode"},"description":{"$ref":"#/components/schemas/AssetDescription"},"uom":{"$ref":"#/components/schemas/AssetUom"}},"required":["id","code","uom"]},"PaymentAdjustmentList":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/PaymentAdjustment"},{"$ref":"#/components/schemas/ScimResourceMetadata"}]}},"PercentagePaymentAdjustment":{"type":"object","properties":{"title":{"type":"string"},"type":{"type":"string","enum":["charge","allowance"]},"calculationType":{"type":"string","enum":["percentage"]},"percent":{"type":"number","minimum":0},"flexible":{"type":"boolean"},"min":{"type":"number","minimum":0},"max":{"type":"number","minimum":0},"archived":{"type":"boolean","readOnly":true}},"required":["title","type","flexible","calculationType"]},"CurrencyPaymentAdjustment":{"type":"object","properties":{"title":{"type":"string"},"type":{"type":"string","enum":["charge","allowance"]},"calculationType":{"type":"string","enum":["currency"]},"amount":{"type":"number","minimum":0},"currency":{"type":"string"},"flexible":{"type":"boolean"},"min":{"type":"number","minimum":0},"max":{"type":"number","minimum":0},"archived":{"type":"boolean","readOnly":true}},"required":["title","type","flexible","calculationType","currency"]},"PaymentAdjustment":{"oneOf":[{"$ref":"#/components/schemas/PercentagePaymentAdjustment"},{"$ref":"#/components/schemas/CurrencyPaymentAdjustment"}]},"CreateBatchTransactionRequest":{"title":"Batch Transaction","type":"object","properties":{"receiverId":{"$ref":"#/components/schemas/Id"},"senderId":{"$ref":"#/components/schemas/Id"},"transfers":{"type":"array","items":{"title":"Batch Transaction Transfer","type":"object","properties":{"assetId":{"$ref":"#/components/schemas/Id"},"quantity":{"title":"Amount to be Exchanged","type":"number","minimum":0,"exclusiveMinimum":true},"sourceOperations":{"$ref":"#/components/schemas/SourceOperations"},"effectiveDate":{"$ref":"#/components/schemas/EffectiveDate"},"effectiveLocation":{"$ref":"#/components/schemas/EffectiveLocation"}},"additionalProperties":false,"required":["assetId","quantity"]},"minItems":1},"properties":{"type":"object","additionalProperties":true}},"required":["receiverId","senderId","transfers"],"additionalProperties":false},"AssetDepositTransaction":{"type":"object","properties":{"description":{"type":"string"},"holderId":{"type":"string"},"holder":{"$ref":"#/components/schemas/TransactionParty"},"type":{"type":"string","enum":["deposit"]},"id":{"$ref":"#/components/schemas/Id"},"transactionId":{"$ref":"#/components/schemas/Id"},"sent":{"type":"number"},"qty":{"type":"number"},"creatorId":{"$ref":"#/components/schemas/Id"},"creator":{"$ref":"#/components/schemas/TransactionParty"},"code":{"type":"string"},"assetIds":{"type":"array","items":{"$ref":"#/components/schemas/Id"}},"allCodes":{"type":"array","items":{"type":"string"}},"transfers":{"type":"array","items":{"type":"string"}},"participants":{"type":"array","items":{"$ref":"#/components/schemas/Id"}},"location":{"$ref":"#/components/schemas/GeoCoordinates"}},"readOnly":true,"required":["holderId","holder","type","id","transactionId","sent","qty","creatorId","creator","code","assetIds","allCodes","transfers","participants"]},"AssetTransferOperation":{"type":"object","title":"Asset Transfer","description":"Movement of some asset amount between two accounts, denoted `sender` and `receiver`","properties":{"isDraft":{"type":"boolean","enum":[false],"writeOnly":true},"id":{"$ref":"#/components/schemas/ImmutableId"},"transactionId":{"$ref":"#/components/schemas/ImmutableId"},"direction":{"title":"Transfer Direction","type":"string","enum":["in","out"],"readOnly":true},"assetId":{"$ref":"#/components/schemas/Id"},"exchangingAssetId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"description":"ID of the asset being used as a payment for the current transfer"}]},"code":{"allOf":[{"$ref":"#/components/schemas/AssetCode"},{"readOnly":true}]},"description":{"allOf":[{"$ref":"#/components/schemas/AssetDescription"},{"readOnly":true}]},"uom":{"allOf":[{"$ref":"#/components/schemas/AssetUom"},{"readOnly":true}]},"qty":{"title":"Quantity","type":"number","example":1,"readOnly":true},"quantity":{"title":"Amount to be transferred","type":"number","minimum":0,"writeOnly":true},"isCredit":{"title":"Is Credit Asset","type":"boolean","description":"Indicates if \"Credit\" type of asset was transferred","readOnly":true},"sent":{"$ref":"#/components/schemas/ImmutableTimestamp"},"claimToken":{"type":"string","readOnly":true},"hasClaimToken":{"type":"boolean","readOnly":true},"claimed":{"$ref":"#/components/schemas/ImmutableTimestamp"},"received":{"$ref":"#/components/schemas/ImmutableTimestamp"},"message":{"title":"Message to Receiver","type":"string","description":"Optional message for transfer receiver","maxLength":1024},"price":{"title":"Asset Price","type":"number","minimum":0},"priceCurrency":{"title":"Asset Price Currency","type":"string","minLength":3,"maxLength":3,"example":"USD"},"sender":{"title":"Sender","type":"object","properties":{"id":{"title":"Sender ID","type":"string","minLength":32,"maxLength":32,"example":"00000000000000000000000000000000"},"name":{"title":"Sender Name","type":"string"},"isOrg":{"title":"Sender is Org","type":"boolean"},"externalId":{"title":"External Id","type":"string"}},"readOnly":true},"senderId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"writeOnly":true}]},"receiver":{"type":"object","title":"Receiver","properties":{"id":{"title":"Receiver ID","type":"string","minLength":32,"maxLength":32,"example":"00000000000000000000000000000000"},"name":{"title":"Receiver Name","type":"string"},"isOrg":{"title":"Receiver is Org","type":"boolean"},"photoUrl":{"title":"Receiver Photo","type":"string","format":"url"},"photoEtag":{"title":"Receiver Photo ETag","type":"string"},"externalId":{"title":"External Id","type":"string"}},"readOnly":true},"receiverId":{"allOf":[{"$ref":"#/components/schemas/Id"},{"writeOnly":true}]},"destination":{"$ref":"#/components/schemas/PaymentDestination"},"initiatedBy":{"type":"object","title":"Initiated By","description":"Account that initiated the transfer","properties":{"id":{"$ref":"#/components/schemas/ImmutableId"},"name":{"title":"Initiated By","type":"string"}},"readOnly":true},"initiatedByUser":{"type":"object","title":"Initiated By User","description":"User that initiated the transfer","properties":{"id":{"title":"Initiated By User ID","type":"string","minLength":32,"maxLength":32,"example":"00000000000000000000000000000000"},"name":{"title":"Initiated By User","type":"string"}},"readOnly":true},"agency":{"type":"object","title":"Agency","description":"For transfers sent to a BanQu Agency, the field contains Agency account that made the cash out","properties":{"id":{"title":"Agency ID","type":"string","minLength":32,"maxLength":32,"example":"00000000000000000000000000000000"},"name":{"type":"string"},"address":{"type":"string"}},"readOnly":true},"agent":{"type":"object","title":"Agent","description":"For transfers sent to a BanQu Agency, the field contains Agent that made the cash out","properties":{"id":{"title":"Agent ID","type":"string","minLength":32,"maxLength":32,"example":"00000000000000000000000000000000"},"name":{"title":"Agent Name","type":"string"}},"readOnly":true},"properties":{"type":"object","title":"Transfer Properties","description":"Key-value pairs with custom transfer properties","additionalProperties":true,"example":{"poNumber":"000001","stockCode":"7b35e21b717844"}},"assetAttachments":{"allOf":[{"$ref":"#/components/schemas/Attachments"},{"readOnly":true}]},"draft":{"type":"boolean","description":"Flag that indicates the transfer is not completed. Usually until it is confirmed by a receiver","readOnly":true},"sourceOperations":{"$ref":"#/components/schemas/SourceOperations"},"explicitAvailableQty":{"type":"number","description":"Amount that wasn't yet used as an explicit source for another operation over same asset in receiver's account. Confirmation with a changed quantity affects this number too","readOnly":true},"availableQty":{"type":"number","description":"Amount that wasn't yet used as an explicit and/or implicit source for another operation over same asset in receiver's account","readOnly":true},"receivedQty":{"type":"number","description":"Amount that was confirmed by receiver. Undefined until confirmation","readOnly":true},"receiverComment":{"type":"string","description":"Optional text message from the user who confirmed transfer","readOnly":true},"partiallyConfirmedQty":{"type":"number","description":"Defines absolute confirmed quantity of a partially confirmed transfer. Example, initial transfer has amount 10kg. It was split into 3kg and 7 kg transfers upstream. The last transfer was confirmed at 90%. partiallyConfirmedQty will equal 6.3kg (90% of 7kg). partiallyConfirmedShare will equal 0.9","readOnly":true},"partiallyConfirmedShare":{"type":"number","description":"A transfer amount can be explicitly sourced into different batches (upstream). When cascade confirmation is ON this can result in partial confirmation of initial transfer quantity. This property defines what fraction of this transfer was confirmed","readOnly":true},"sourcesCount":{"allOf":[{"$ref":"#/components/schemas/SourcesCount"},{"readOnly":true}]},"effectiveDate":{"$ref":"#/components/schemas/EffectiveDate"},"effectiveLocation":{"$ref":"#/components/schemas/EffectiveLocation"}},"additionalProperties":false,"required":["senderId","receiverId","assetId","quantity"]},"DraftPaymentOperation":{"title":"Payment Draft","type":"object","additionalProperties":false,"properties":{"isDraft":{"type":"boolean","enum":[true],"writeOnly":true},"assetId":{"$ref":"#/components/schemas/Id"},"quantity":{"title":"Payment Amount","type":"number","minimum":0},"senderId":{"$ref":"#/components/schemas/Id"},"receiverId":{"$ref":"#/components/schemas/Id"},"destinationProvider":{"$ref":"#/components/schemas/PaymentDestinationProvider"},"effectiveDate":{"$ref":"#/components/schemas/EffectiveDate"},"destinationId":{"$ref":"#/components/schemas/PaymentDestinationId"},"destinationType":{"$ref":"#/components/schemas/PaymentDestinationType"}},"required":["isDraft","senderId","receiverId","assetId","quantity"]},"PaymentOperation":{"title":"Payment","type":"object","additionalProperties":false,"properties":{"isDraft":{"type":"boolean","enum":[false],"writeOnly":true},"assetId":{"$ref":"#/components/schemas/Id"},"quantity":{"title":"Payment Amount","type":"number","minimum":0},"senderId":{"$ref":"#/components/schemas/Id"},"receiverId":{"$ref":"#/components/schemas/Id"},"destinationProvider":{"$ref":"#/components/schemas/PaymentDestinationProvider"},"destinationId":{"$ref":"#/components/schemas/PaymentDestinationId"},"destinationType":{"$ref":"#/components/schemas/PaymentDestinationType"}},"required":["senderId","receiverId","assetId","quantity","destinationProvider"]},"PaymentDestinationProvider":{"title":"Payment Destination Provider","description":"Payment provider where the payment should be delivered to","type":"string","enum":["banqu-agency","mtn-zambia","6dot50pay-zaf","mtn-uganda","tigo-tanzania","celbux-zaf","airtel","zamtel","vodacom"]},"PaymentDestinationId":{"title":"Destination Identifier","description":"Destination phone number for mobile providers; BanQu agency ID for banqu-agency provider","type":"string"},"PaymentDestinationType":{"title":"Destination Type","description":"mobile for payments by phone number; payCode for 6DOT50 partner transfer","enum":["mobile","new-mobile","payCode"]},"PaymentAdjustmentOperation":{"title":"Payment Adjustment","description":"Change transaction amount using global or asset related adjustments","type":"object","additionalProperties":false,"properties":{"paymentAdjustmentId":{"type":"string","minLength":1},"appliedToAssetId":{"$ref":"#/components/schemas/Id"},"quantity":{"type":"number","minimum":0}},"required":["paymentAdjustmentId","quantity"]},"CreateTransactionRequest":{"type":"array","minItems":1,"items":{"oneOf":[{"$ref":"#/components/schemas/AssetTransferOperation"},{"$ref":"#/components/schemas/PaymentOperation"},{"$ref":"#/components/schemas/DraftPaymentOperation"},{"$ref":"#/components/schemas/PaymentAdjustmentOperation"}]},"example":[{"assetId":"0d903320a0c5494d85c325fc4936dcad","exchangingAssetId":"2992356a55b242f2a97b140d46930ffa","quantity":2000,"senderId":"247521e4ce06472ebaf5bdf08d3c4a3e","receiverId":"8f4f517528464f428afddce6880128b6","properties":{"distance":150},"price":1.4,"priceCurrency":"USD"},{"isDraft":false,"assetId":"2992356a55b242f2a97b140d46930ffa","quantity":2800,"senderId":"8f4f517528464f428afddce6880128b6","receiverId":"247521e4ce06472ebaf5bdf08d3c4a3e"}]},"FinalizeDraftTransactionRequest":{"type":"array","minItems":1,"items":{"anyOf":[{"$ref":"#/components/schemas/PaymentAdjustmentOperation"},{"title":"Persisted payment adjustment operation","description":"Persisted payment adjustment operation with changed quantity","type":"object","properties":{"id":{"$ref":"#/components/schemas/Id"},"quantity":{"type":"number"}},"additionalProperties":false,"required":["id","quantity"]},{"title":"Persisted asset operation","type":"object","properties":{"id":{"$ref":"#/components/schemas/Id"},"quantity":{"type":"number","minimum":0},"price":{"type":"number","minimum":0},"priceCurrency":{"type":"string","minLength":3,"maxLength":3,"example":"USD"},"properties":{"type":"object","additionalProperties":true}},"additionalProperties":false,"required":["id","quantity"]},{"$ref":"#/components/schemas/PaymentOperation"},{"title":"Persisted payment operation","description":"Persisted payment operation with changed quantity or/and destination provider","type":"object","properties":{"id":{"$ref":"#/components/schemas/Id"},"quantity":{"type":"number","minimum":0},"destinationProvider":{"$ref":"#/components/schemas/PaymentDestinationProvider"},"destinationId":{"$ref":"#/components/schemas/PaymentDestinationId"},"destinationType":{"$ref":"#/components/schemas/PaymentDestinationType"}},"additionalProperties":false,"required":["quantity","id"]},{"$ref":"#/components/schemas/AssetTransferOperation"}]}},"SourceOperations":{"type":"array","description":"List of incoming asset transfers that are used as sources for this transaction","items":{"type":"object","additionalProperties":false,"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/Id"},{"description":"Source operation Id"}]},"sourcedQty":{"type":"number","minimum":0,"exclusiveMinimum":true}},"required":["id","sourcedQty"]}},"TransactionStats":{"type":"object","properties":{"drafts":{"type":"number"},"incomingPending":{"type":"number"},"outgoingPending":{"type":"number"}}},"ExchangeTransaction":{"type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/ImmutableId"},"allCodes":{"type":"array","items":{"type":"string"}},"assetIds":{"type":"array","items":{"type":"string"}},"receiverId":{"$ref":"#/components/schemas/Id"},"type":{"type":"string","enum":["batch","trade","exchange","transfer"]},"unconfirmedAssetIds":{"type":"array","items":{"$ref":"#/components/schemas/Id"}},"destinationProvider":{"$ref":"#/components/schemas/PaymentDestinationProvider"},"destinationId":{"$ref":"#/components/schemas/PaymentDestinationId"},"destinationType":{"$ref":"#/components/schemas/PaymentDestinationType"},"initiatedBy":{"$ref":"#/components/schemas/TransactionParty"},"initiatedByUser":{"allOf":[{"$ref":"#/components/schemas/TransactionParty"},{"readOnly":true}]},"sender":{"$ref":"#/components/schemas/TransactionParty"},"receiver":{"$ref":"#/components/schemas/TransactionParty"},"agency":{"$ref":"#/components/schemas/TransactionParty"},"agent":{"$ref":"#/components/schemas/TransactionParty"},"qty":{"type":"number","minimum":0,"exclusiveMinimum":true},"price":{"type":"number","minimum":0},"priceCurrency":{"type":"string","minLength":3,"maxLength":3,"example":"USD"},"sent":{"type":"number","readOnly":true},"claimed":{"type":"number","readOnly":true},"received":{"type":"number","readOnly":true},"properties":{"type":"object"},"message":{"type":"string"},"transactionId":{"type":"string"},"direction":{"type":"string"},"code":{"type":"string"},"uom":{"$ref":"#/components/schemas/AssetUom"},"description":{"type":"string"},"initiatedByUserId":{"type":"string"},"assetAttachments":{"$ref":"#/components/schemas/Attachments"},"participants":{"type":"array","items":{"type":"string"}}},"required":["receiverId","qty"]},"Transaction":{"oneOf":[{"$ref":"#/components/schemas/RevertTransaction"},{"$ref":"#/components/schemas/AssetDepositTransaction"},{"$ref":"#/components/schemas/ExchangeTransaction"},{"$ref":"#/components/schemas/AssetTransformationTransaction"}]},"RevertTransaction":{"type":"object","properties":{"reason":{"type":"string","minLength":1},"effectiveDate":{"$ref":"#/components/schemas/EffectiveDate"},"effectiveLocation":{"$ref":"#/components/schemas/EffectiveLocation"}},"required":["reason"],"additionalProperties":false},"PaymentDestination":{"oneOf":[{"$ref":"#/components/schemas/AssetMobileDestination"},{"$ref":"#/components/schemas/AssetAgencyDestination"}]},"AssetAgencyDestination":{"type":"object","title":"Agency Payment Destination","description":"Where the transfer was sent to (i.e. BanQu agency)","properties":{"id":{"title":"Destination ID","type":"string","description":"Receiver phone number (for transfers to mobile wallets)"},"name":{"title":"Destination Name","type":"string","description":"Name of BanQu agency (for transfers to specific BanQu agency)"},"address":{"title":"Destination Address","type":"string","description":"Address of BanQu agency (for transfers to specific BanQu agency)"}},"required":["id","name"],"readOnly":true},"AssetMobileDestination":{"type":"object","title":"Mobile Payment Destination","description":"Mobile wallet where the monetary transfer was sent to","properties":{"provider":{"$ref":"#/components/schemas/PaymentDestinationProvider"},"id":{"$ref":"#/components/schemas/PaymentDestinationId"},"type":{"$ref":"#/components/schemas/PaymentDestinationType"}},"required":["id","provider"],"readOnly":true},"ChainedOperation":{"type":"object","properties":{"qty":{"title":"Quantity","description":"The transaction amount or the amount of an existing transaction selected as a source","type":"number"},"asset":{"type":"object","properties":{"uom":{"title":"Unit of Measure","type":"string"},"name":{"title":"Asset Name","type":"string"},"code":{"title":"Asset Code","type":"string"},"id":{"title":"Asset ID","type":"string"}}},"sent":{"title":"Date","type":"number","format":"date-time"},"type":{"title":"Type","description":"transfer - an asset moving from one connection to another\ntransformation - the inputs of a transformation (one or more assets turned into another asset)\ntransformation-result - the output of a transformation","type":"string","enum":["transfer","deposit","transformation","transformation-result"]},"properties":{"type":"object","properties":{},"additionalProperties":true},"from":{"type":"object","properties":{"id":{"title":"From ID","type":"string","minLength":32,"maxLength":32,"example":"00000000000000000000000000000000"},"displayName":{"title":"From","type":"string"},"isOrg":{"type":"boolean"},"photoUrl":{"type":"string","format":"url"},"photoEtag":{"type":"string"}}},"to":{"type":"object","properties":{"id":{"title":"To ID","type":"string","minLength":32,"maxLength":32,"example":"00000000000000000000000000000000"},"displayName":{"title":"To","type":"string"},"isOrg":{"type":"boolean"},"photoUrl":{"type":"string","format":"url"},"photoEtag":{"type":"string"}}},"usageInUnits":{"title":"Mass sourced to the top","type":"number","description":"how much of this operation made it to the top of chain, in asset's units of measure"},"transferredQty":{"title":"Quantity in Original Operation","description":"The full amount of the original transaction the source is selected from","type":"number"},"immediateUsage":{"title":"Mass % sourced from this operation","type":"number","format":"percent","description":"how much of this operation made to the one level higher in chain, in percents"},"usage":{"title":"Quantity % sourced to the top","type":"number","format":"percent","description":"how much of this operation made it to the top of chain, in percents"},"path":{"type":"array","title":"Historical Order","items":{"type":"string"},"description":"operation's parents' and own name to rebuild tree from the list"},"depth":{"type":"string"},"id":{"title":"Operation ID","type":"string"}}},"ChainOfCustody":{"type":"object","properties":{"operations":{"type":"array","items":{"$ref":"#/components/schemas/ChainedOperation"}},"forms":{"description":"A Record object which has form ids as keys and form template as value","additionalProperties":{"$ref":"#/components/schemas/Form"}},"profiles":{"description":"A Record object which has uids as keys and profile as value","additionalProperties":{"$ref":"#/components/schemas/Profile"}},"profilesByForms":{"description":"A Record object which has form ids as keys and list of profile ids as value","additionalProperties":{"type":"array","items":{"type":"string","title":"Profile Id"}}},"dataEntries":{"description":"A Record object which has data entry ids as keys and data entry as value","additionalProperties":{"type":"object"}},"dataEntriesByForms":{"description":"A Record object which has form ids as keys and list of entry ids as value","additionalProperties":{"type":"object"}},"assetForms":{"description":"A Record object which has asset ids as keys and form template as value","additionalProperties":{"$ref":"#/components/schemas/Form"}}}},"SupplierProfile":{"properties":{"displayName":{"type":"string","title":"Name"},"id":{"type":"string","title":"Id"},"phoneNumber":{"type":"string","title":"Phone Number"},"email":{"type":"string","title":"Email"},"userName":{"type":"string","title":"userName"}}},"ExcelTableTheme":{"type":"string","enum":["TableStyleLight1","TableStyleLight2","TableStyleLight3","TableStyleLight4","TableStyleLight5","TableStyleLight6","TableStyleLight7","TableStyleLight8","TableStyleLight9","TableStyleLight10","TableStyleLight11","TableStyleLight12","TableStyleLight13","TableStyleLight14","TableStyleLight15","TableStyleLight16","TableStyleLight17","TableStyleLight18","TableStyleLight19","TableStyleLight20","TableStyleLight21","TableStyleMedium1","TableStyleMedium2","TableStyleMedium3","TableStyleMedium4","TableStyleMedium5","TableStyleMedium6","TableStyleMedium7","TableStyleMedium8","TableStyleMedium9","TableStyleMedium10","TableStyleMedium11","TableStyleMedium12","TableStyleMedium13","TableStyleMedium14","TableStyleMedium15","TableStyleMedium16","TableStyleMedium17","TableStyleMedium18","TableStyleMedium19","TableStyleMedium20","TableStyleMedium21","TableStyleMedium22","TableStyleMedium23","TableStyleMedium24","TableStyleMedium25","TableStyleMedium26","TableStyleMedium27","TableStyleMedium28","TableStyleDark1","TableStyleDark2","TableStyleDark3","TableStyleDark4","TableStyleDark5","TableStyleDark6","TableStyleDark7","TableStyleDark8","TableStyleDark9","TableStyleDark10","TableStyleDark11"]},"AssetDeposit":{"type":"object","properties":{"id":{"type":"string","minLength":32,"maxLength":32},"assetId":{"type":"string","minLength":32,"maxLength":32},"code":{"$ref":"#/components/schemas/AssetCode"},"uom":{"$ref":"#/components/schemas/AssetUom"},"description":{"$ref":"#/components/schemas/AssetDescription"},"qty":{"type":"string"},"sent":{"type":"number"},"creator":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ImmutableId"},"name":{"type":"string"}}},"creatorUser":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ImmutableId"},"name":{"type":"string"}}},"holder":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ImmutableId"},"name":{"type":"string"}}}},"required":["id","assetId","code","uom","qty","sent","creator","holder"]},"AnyAssetOperation":{"oneOf":[{"$ref":"#/components/schemas/AssetTransferOperation"},{"$ref":"#/components/schemas/AssetTransformationOperation"},{"$ref":"#/components/schemas/AssetDeposit"}]},"ConfirmTransferReceipt":{"type":"object","properties":{"quantity":{"title":"Quantity","type":"number","example":1},"comment":{"title":"Rejection comment","type":"string","maxLength":40,"example":"Part of it was lost"}},"required":["quantity"]},"SourcesCount":{"type":"number","description":"Indicates number of operations that serve as explicit or implicit sources for this asset operation. Appears in the object when request contains sourcesGroupingMethod in query"},"RejectTransferReceipt":{"type":"object","properties":{"comment":{"title":"Rejection comment","type":"string","maxLength":40,"example":"It was lost"}}},"ClaimedTransfer":{"type":"object","properties":{"transferId":{"type":"string"},"code":{"$ref":"#/components/schemas/AssetCode"},"description":{"$ref":"#/components/schemas/AssetDescription"},"uom":{"$ref":"#/components/schemas/AssetUom"},"qty":{"type":"string"},"price":{"type":"number"},"priceCurrency":{"type":"string"},"receiver":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"type":"string"},"photoEtag":{"type":"string"}}}}},"FormDto":{"type":"object","properties":{"id":{"type":"string","description":"Form ID","readOnly":true},"owner":{"type":"object","properties":{"id":{"type":"string","description":"ID of the form owner account","readOnly":true},"name":{"type":"string","readOnly":true}},"readOnly":true},"title":{"$ref":"#/components/schemas/LocalizedString"}},"required":["title"]},"Form":{"type":"object","title":"Form","properties":{"id":{"$ref":"#/components/schemas/ImmutableId"},"title":{"$ref":"#/components/schemas/LocalizedString"},"version":{"type":"number","readOnly":true,"description":"Form template age. It is increased on server side with every modification"},"sharing":{"title":"Form Type","oneOf":[{"title":"Transaction Properties Form","type":"object","properties":{"level":{"type":"string","enum":["batch"]},"txTypes":{"description":"The transaction types the form can be used for","type":"array","items":{"type":"string","enum":["batch","transformation"]},"minItems":1,"uniqueItems":true}},"additionalProperties":false},{"title":"Private Data Entry Form","type":"object","properties":{"level":{"type":"string","enum":["private"]}},"additionalProperties":false},{"title":"Fragment Form","type":"object","properties":{"level":{"type":"string","enum":["fragment"]}},"additionalProperties":false},{"title":"Shared Data Entry Form","type":"object","properties":{"level":{"type":"string","enum":["shared"]}},"additionalProperties":false},{"title":"User Profile Form","type":"object","properties":{"level":{"type":"string","enum":["replace"]},"profileSectionName":{"type":"string","pattern":"^(urn:banqu:schemas:[a-f\\d]{32}:User:)?[a-zA-Z][\\da-zA-Z]*$","minLength":1},"reportingSectionName":{"type":"string","pattern":"^(urn:banqu:schemas:[a-f\\d]{32}:User:[a-zA-Z][\\da-zA-Z]*)?$"},"priority":{"type":"number","minimum":0},"replaceProfileSections":{"type":"array","items":{"type":"string"}},"profileSectionNamePrefix":{"description":"Used as a backdoor in API to be able to change a client form into a standard form","type":"string","enum":["urn:banqu:schemas:scim:User:"]}},"additionalProperties":false,"required":["level","profileSectionName"]},{"title":"Org Profile Form","type":"object","properties":{"level":{"type":"string","enum":["org-profile"]},"profileSectionName":{"type":"string","pattern":"^(urn:banqu:schemas:[a-f\\d]{32}:Org:)?[a-zA-Z][\\da-zA-Z]*$","minLength":1},"profileSectionNamePrefix":{"description":"Used as a backdoor in API to be able to change a client form into a standard form","type":"string","enum":["urn:banqu:schemas:scim:Org:"]},"priority":{"type":"number","minimum":0}},"additionalProperties":false,"required":["level","profileSectionName"]}],"required":["level"]},"appearance":{"title":"Form Appearance Settings","type":"object","properties":{"collapsingType":{"type":"string","enum":["accordion","collapsed","expanded"]},"showScore":{"type":"boolean"}},"additionalProperties":false},"usagePreferences":{"title":"Data Entry Form Usage Preferences","type":"object","properties":{"assign":{"type":"boolean","description":"If true, the form can be assigned to connected identities"},"navbarCreate":{"type":"boolean","description":"If true, the form data entry can be created from the navbar"},"identityCreate":{"type":"boolean","description":"If true, the form data entry can be created from the connected identity page"}},"additionalProperties":false},"deletedFrozenFields":{"type":"object","readOnly":true,"description":"A map containing all deleted frozen fields (available for restoration). Managed on serverside"},"owner":{"$ref":"#/components/schemas/ImmutableId"},"sections":{"title":"Form Sections","type":"array","items":{"$ref":"#/components/schemas/FormSection"}},"groups":{"title":"Form Groups","type":"array","items":{"$ref":"#/components/schemas/FormGroup"}},"archived":{"type":"boolean","description":"Indicates if form is archived","readOnly":true},"thirdPartyValidation":{"type":"boolean","description":"On profile forms indicates if the form data can be reviewed by a third-party contract specified in data entry"}},"required":["title","sections"],"additionalProperties":false,"example":{"title":{"en":"My Form"},"version":1,"sections":[{"title":{"en":"Some List"},"name":"section1","multiple":true,"required":true,"fields":[{"name":"field1","type":"text","title":{"en":"Field Title"},"required":true,"visibility":{"approver":"readonly","reviewer":"hidden","responder":"edit"}}]}],"sharing":{"level":"shared"}}},"FormDataEntry":{"description":"Form data entry, assigned by a connected identity or created manually","properties":{"id":{"type":"string","readOnly":true,"title":"Data Entry ID"},"form":{"type":"object","readOnly":true,"properties":{"id":{"type":"string","title":"Form ID"},"title":{"$ref":"#/components/schemas/LocalizedString"}}},"previewFields":{"type":"array","readOnly":true,"items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"title":{"$ref":"#/components/schemas/LocalizedString"},"primary":{"type":"boolean"},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"$ref":"#/components/schemas/LocalizedString"}]}},"additionalProperties":false}},"data":{"$ref":"#/components/schemas/FormData"},"owner":{"type":"object","readOnly":true,"properties":{"id":{"type":"string","title":"Owner ID"},"displayName":{"type":"string","title":"Owner"},"isOrg":{"type":"boolean","title":"Owner is Org"},"emails":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","title":"Owner Email Type"},"value":{"type":"string","title":"Owner Email"},"primary":{"type":"boolean","title":"Is Primary Email"}}}},"photos":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","title":"Owner Photo URL"},"etag":{"type":"string","title":"Owner Photo Signature"},"primary":{"type":"boolean","title":"Is Primary Photo"}}}}}},"responders":{"type":"array","items":{"type":"object","readOnly":true,"properties":{"id":{"type":"string","title":"Responder ID"},"displayName":{"type":"string","title":"Responder"},"isOrg":{"type":"boolean","title":"Responder is Org"},"emails":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","title":"Responder Email Type"},"value":{"type":"string","title":"Responder Email"},"primary":{"type":"boolean","title":"Is Primary Email"}}}},"photos":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","title":"Responder Photo URL"},"etag":{"type":"string","title":"Responder Photo Signature"},"primary":{"type":"boolean","title":"Is Primary Photo"}}}}}}},"submitter":{"type":"object","readOnly":true,"properties":{"id":{"type":"string","title":"Submitter ID"},"displayName":{"type":"string","title":"Submitter"},"isOrg":{"type":"boolean","title":"Submitter is Org"},"emails":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","title":"Submitter Email Type"},"value":{"type":"string","title":"Submitter Email"},"primary":{"type":"boolean","title":"Is Primary Email"}}}},"photos":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","title":"Submitter Photo URL"},"etag":{"type":"string","title":"Submitter Photo Signature"},"primary":{"type":"boolean","title":"Is Primary Photo"}}}}}},"submitterAccount":{"type":"object","readOnly":true,"properties":{"id":{"type":"string","title":"Submitter Account ID"},"displayName":{"type":"string","title":"Submitter Account"},"isOrg":{"type":"boolean","title":"Submitter Account is Org"},"photos":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","title":"Submitter Account Photo URL"},"etag":{"type":"string","title":"Submitter Account Photo Signature"},"primary":{"type":"boolean","title":"Is Primary Photo"}}}}}},"reviews":{"type":"array","readOnly":true,"items":{"type":"object","properties":{"by":{"type":"string"},"at":{"type":"number"},"reviewed":{"type":"boolean"},"approved":{"type":"boolean"},"rejected":{"type":"boolean"},"comment":{"type":"string"}}}},"createdAt":{"type":"number","readOnly":true,"title":"Created At","example":1568894551000},"submittedAt":{"type":"number","readOnly":true,"title":"Submitted At","example":1568894551000},"submitted":{"type":"boolean","readOnly":true,"title":"Is Submitted"},"reviewed":{"type":"boolean","readOnly":true,"title":"Is Reviewed"},"approved":{"type":"boolean","readOnly":true,"title":"Is Approved"},"rejected":{"type":"boolean","readOnly":true,"title":"Is Rejected"},"denied":{"type":"boolean","readOnly":true,"title":"Is Denied"},"archived":{"type":"boolean","readOnly":true,"title":"Is Archived"}}},"FormSection":{"title":"Form Section","type":"object","properties":{"$entityId":{"type":"string","description":"Internal unique identifier for the section"},"title":{"$ref":"#/components/schemas/OptionalLocalizedString"},"description":{"$ref":"#/components/schemas/OptionalLocalizedString"},"name":{"$ref":"#/components/schemas/JsonIdentifier"},"multiple":{"type":"boolean","description":"If multiple instances of the section are allowed"},"required":{"type":"boolean","description":"If at least one of the section instances is required"},"requiredIf":{"type":"string"},"visibleIf":{"type":"string"},"weight":{"type":"number","description":"A numerical value representing the importance of this field in the overall score calculation. Higher values indicate greater importance."},"threshold":{"type":"number","minimum":0,"description":"A specific value that the score must meet or exceed for a particular action or decision to be triggered."},"layout":{"type":"string","description":"Section markup layout","enum":["horizontal","vertical","table"]},"fields":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/FormField"},{"$ref":"#/components/schemas/CheckboxField"},{"$ref":"#/components/schemas/FormFieldWithItems"},{"$ref":"#/components/schemas/FormMarkupElement"},{"$ref":"#/components/schemas/FragmentField"}]}},"groupId":{"type":"string","description":"Identifier of the group this section belongs to"},"frozen":{"type":"boolean","readOnly":true}},"required":["fields"]},"FormField":{"title":"Form Field","type":"object","properties":{"$entityId":{"type":"string","description":"Internal unique identifier for the field"},"name":{"$ref":"#/components/schemas/JsonNestedIdentifier"},"type":{"type":"string","enum":["text","textarea","connectionSelect","assetSelect","countrySelect","currencySelect","dataEntrySelect","datetime","file","geoPosition","polygon","barcode"]},"title":{"$ref":"#/components/schemas/LocalizedString"},"placeholder":{"$ref":"#/components/schemas/OptionalLocalizedString"},"description":{"$ref":"#/components/schemas/OptionalLocalizedString"},"descriptionVariant":{"$ref":"#/components/schemas/DescriptionVariant"},"required":{"type":"boolean"},"validation":{"type":"string"},"parentFieldName":{"$ref":"#/components/schemas/ParentFieldName"},"visibility":{"$ref":"#/components/schemas/FormElementVisibility"},"format":{"type":"string","description":"Format of 'datetime' field type","enum":["date","time","date-time"]},"primary":{"type":"boolean","description":"Whether field is a primary key or part of a primary key. Primary key values should be unique across multiple form data entries of a same user"},"globalPrimary":{"type":"boolean","description":"Whether field is a primary key or part of a primary key. Primary key values should be unique across multiple form data entries of a same user"},"uniqueAcrossInstances":{"type":"boolean","description":"Unique across section instances when form section is repeatable"},"size":{"type":"integer","description":"The number of slots preserved for the field in a table column","minimum":1,"maximum":12},"displayTotals":{"type":"boolean","description":"When enabled, the sum of all field values is displayed in the totals row on the UI"},"weight":{"type":"number","description":"A numerical value representing the importance of this field in the overall score calculation. Higher values indicate greater importance."},"isParent":{"type":"boolean","description":"Mark the selected connection as a parent of the data entry"},"connectionType":{"type":"string","description":"Connection type to filter connections in the connection select field","enum":["org","user"]},"importanceArea":{"$ref":"#/components/schemas/FormFieldImportance"},"frozen":{"type":"boolean","readOnly":true},"formula":{"type":"string","description":"Formula for calculated mode of the field"}},"required":["name","type","title"]},"CheckboxField":{"title":"Checkbox Field","type":"object","properties":{"$entityId":{"type":"string","description":"Internal unique identifier for the field"},"name":{"$ref":"#/components/schemas/JsonNestedIdentifier"},"type":{"type":"string","enum":["checkbox"]},"title":{"$ref":"#/components/schemas/OptionalLocalizedString"},"placeholder":{"$ref":"#/components/schemas/OptionalLocalizedString"},"description":{"$ref":"#/components/schemas/OptionalLocalizedString"},"descriptionVariant":{"$ref":"#/components/schemas/DescriptionVariant"},"required":{"type":"boolean"},"visibility":{"$ref":"#/components/schemas/FormElementVisibility"},"size":{"type":"integer","description":"The number of slots preserved for the field in a table column","minimum":1,"maximum":12},"weight":{"type":"number","description":"A numerical value representing the importance of this field in the overall score calculation. Higher values indicate greater importance."},"importanceArea":{"$ref":"#/components/schemas/FormFieldImportance"},"frozen":{"type":"boolean","readOnly":true},"uniqueAcrossInstances":{"enum":[false]},"defaultValue":{"type":"boolean","description":"Default value for this checkbox field"}},"required":["name","type"]},"FormFieldWithItems":{"title":"Form Field with Items","type":"object","properties":{"$entityId":{"type":"string","description":"Internal unique identifier for the field"},"name":{"$ref":"#/components/schemas/JsonNestedIdentifier"},"type":{"type":"string","enum":["select","multiSelect","radio"]},"displayAs":{"type":"string","enum":["dropdown","list"]},"title":{"$ref":"#/components/schemas/LocalizedString"},"description":{"$ref":"#/components/schemas/OptionalLocalizedString"},"descriptionVariant":{"$ref":"#/components/schemas/DescriptionVariant"},"required":{"type":"boolean"},"validation":{"type":"string"},"parentFieldName":{"$ref":"#/components/schemas/ParentFieldName"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal unique identifier for the item"},"title":{"$ref":"#/components/schemas/OptionalLocalizedString"},"value":{"type":"string"},"weight":{"type":"number","minimum":-1,"description":"A numerical value representing the importance of this item in the overall score calculation. Higher values indicate greater importance."},"frozen":{"type":"boolean","description":"Indicates if the item is frozen and cannot be modified"},"parentValue":{"type":"string","description":"Value of a parent field that this item belongs to. Used to filter items in a select field based on the parent field value"}},"required":["value"],"additionalProperties":false}},"allowOther":{"type":"boolean"},"visibility":{"$ref":"#/components/schemas/FormElementVisibility"},"primary":{"type":"boolean","description":"Whether field is a primary key or part of a primary key. Primary key values should be unique across multiple form data entries of a same user"},"globalPrimary":{"type":"boolean","description":"Whether field is a primary key or part of a primary key. Primary key values should be unique across multiple form data entries of a same user"},"uniqueAcrossInstances":{"type":"boolean","description":"Unique across section instances when form section is repeatable"},"size":{"type":"integer","description":"The number of slots preserved for the field in a table column","minimum":1,"maximum":12},"displayTotals":{"type":"boolean","description":"When enabled, the sum of all field values is displayed in the totals row on the UI"},"weight":{"type":"number","description":"A numerical value representing the importance of this field in the overall score calculation. Higher values indicate greater importance."},"isParent":{"type":"boolean","description":"Mark the selected connection as a parent of the data entry"},"importanceArea":{"$ref":"#/components/schemas/FormFieldImportance"},"frozen":{"type":"boolean","readOnly":true}},"required":["name","type","title","required"]},"FormMarkupElement":{"title":"Form Markup Element","type":"object","required":["title","type"],"properties":{"type":{"type":"string","enum":["legend","static"]},"url":{"type":"string","format":"url"},"title":{"$ref":"#/components/schemas/LocalizedString"},"description":{"$ref":"#/components/schemas/OptionalLocalizedString"},"visibility":{"$ref":"#/components/schemas/FormElementVisibility"},"$entityId":{"type":"string"},"requiredIf":{"type":"string"},"visibleIf":{"type":"string"}},"additionalProperties":false},"FragmentField":{"title":"Fragment Field","type":"object","required":["fragmentId","type"],"properties":{"type":{"type":"string","enum":["fragment"]},"fragmentId":{"type":"string","minLength":16},"title":{"$ref":"#/components/schemas/LocalizedString"},"placeholder":{"$ref":"#/components/schemas/OptionalLocalizedString"},"description":{"$ref":"#/components/schemas/OptionalLocalizedString"},"descriptionVariant":{"$ref":"#/components/schemas/DescriptionVariant"},"visibility":{"$ref":"#/components/schemas/FormElementVisibility"},"$entityId":{"type":"string"},"requiredIf":{"type":"string"},"visibleIf":{"type":"string"},"required":{"type":"boolean"},"importanceArea":{"$ref":"#/components/schemas/FormFieldImportance"},"frozen":{"type":"boolean","readOnly":true},"primary":{"type":"boolean","description":"Whether field is a primary key or part of a primary key. Primary key values should be unique across multiple form data entries of a same user"},"globalPrimary":{"type":"boolean","description":"Whether field is a primary key or part of a primary key. Primary key values should be unique across multiple form data entries of a same user"},"uniqueAcrossInstances":{"type":"boolean","description":"Unique across section instances when form section is repeatable"},"formula":{"type":"string","description":"Formula for calculated mode of the field"}},"additionalProperties":false},"FormGroup":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/OptionalLocalizedString"},"parentId":{"type":"string","description":"Identifier of the group this sub-group belongs to"},"weight":{"type":"number","minimum":0,"description":"A numerical value representing the importance of this field in the overall score calculation. Higher values indicate greater importance."},"threshold":{"type":"number","minimum":0,"description":"A specific value that the score must meet or exceed for a particular action or decision to be triggered."}},"additionalProperties":false,"required":["id"]},"FormData":{"description":"Form data that matches parent form schema","type":"object","properties":{}},"OptionalComment":{"title":"Optional Comment","properties":{"comment":{"type":"string"}}},"RequiredComment":{"title":"Required Comment","properties":{"comment":{"type":"string"}},"required":["comment"]},"RejectFormData":{"$ref":"#/components/schemas/RequiredComment"},"DenyDataEntry":{"$ref":"#/components/schemas/RequiredComment"},"ReviewDataEntry":{"$ref":"#/components/schemas/OptionalComment"},"ApproveDataEntry":{"$ref":"#/components/schemas/OptionalComment"},"RevokeDataEntryApproval":{"$ref":"#/components/schemas/OptionalComment"},"RevokeDataEntryDenial":{"$ref":"#/components/schemas/OptionalComment"},"AddFormDataResponders":{"title":"Add Form Data Responders Payload","type":"array","items":{"$ref":"#/components/schemas/Id"},"minItems":1,"uniqueItems":true},"ReplaceFormDataResponders":{"title":"Replace Form Data Responders Payload","type":"array","items":{"$ref":"#/components/schemas/Id"},"minItems":1,"uniqueItems":true},"JsonIdentifier":{"type":"string","description":"JSON field name","pattern":"^[$a-zA-Z_][\\da-zA-Z_]*$"},"JsonNestedIdentifier":{"type":"string","description":"JSON field name, optionally nested, e.g., 'field1.subfield2'","pattern":"^[a-zA-Z_][\\da-zA-Z_]*(\\.([a-zA-Z_][\\da-zA-Z_]*|\\d+))*$"},"ParentFieldName":{"type":"string","pattern":"^[a-zA-Z_][\\da-zA-Z_]*(\\[\\]\\.([a-zA-Z_][\\da-zA-Z_]*))?(\\.([a-zA-Z_][\\da-zA-Z_]*|\\d+))*$","description":"Name of a parent field whose selected value filters options in this field. E.g., selecting a connection filters related data entries"},"FormFieldImportance":{"type":"object","properties":{"ui":{"type":"boolean","description":"Field is important for UI"},"reporting":{"type":"boolean","description":"Field is important for reporting"},"coc":{"type":"boolean","description":"Field is important for CoC"}},"additionalProperties":false},"FormElementVisibility":{"oneOf":[{"type":"object","description":"Data-entry or profile form field visibility","required":["approver","reviewer","responder"],"properties":{"approver":{"$ref":"#/components/schemas/ReadWriteVisibility"},"reviewer":{"$ref":"#/components/schemas/ReadWriteHideVisibility"},"responder":{"$ref":"#/components/schemas/ReadWriteHideVisibility"}},"additionalProperties":false},{"type":"object","description":"Transaction form field visibility","required":["initiator","update-by-initiator","participant"],"properties":{"update-by-initiator":{"$ref":"#/components/schemas/ReadWriteHideVisibility"},"participant":{"$ref":"#/components/schemas/ReadWriteHideVisibility"},"initiator":{"$ref":"#/components/schemas/ReadWriteHideVisibility"}},"additionalProperties":false}]},"ReadWriteHideVisibility":{"type":"string","enum":["hidden","readonly","edit"]},"ReadWriteVisibility":{"type":"string","enum":["readonly","edit"]},"DescriptionVariant":{"type":"string","enum":["text","tooltip","long-text"]},"SmartContract":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","description":"Smart contract title"},"authToken":{"type":"string","description":"Optional auth token to use for smart contract authentication. Write-only property"},"authTokenSig":{"type":"string","description":"Signature of the stored auth token for its presence and uniqueness validation","readOnly":true},"workflow":{"type":"object","additionalProperties":false,"properties":{"triggerId":{"type":"string"},"steps":{"$ref":"#/components/schemas/WorkflowSteps"}},"required":["triggerId","steps"]},"ownerId":{"type":"string","readOnly":true}},"required":["title","workflow"]},"WorkflowStepName":{"type":["string","null"],"description":"Optional unique alpha-numeric name of the step. Data produced during the step execution can be referred by this name","pattern":"^[a-zA-Z_$][\\da-zA-Z_]*$"},"WorkflowStepInput":{"type":["string","null"],"description":"Name of one of the previous steps that should be used as a primary input. By default the latest step name is used","pattern":"^[a-zA-Z_$][\\da-zA-Z_]*$"},"WorkflowMapping":{"title":"Workflow Mapping","type":"object","additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/WorkflowStepName"},"input":{"$ref":"#/components/schemas/WorkflowStepInput"},"type":{"type":"string","enum":["map"]},"mapping":{"$ref":"#/components/schemas/Mapping"}},"required":["type","mapping"]},"WorkflowFilter":{"title":"Workflow Filter","type":"object","additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/WorkflowStepName"},"input":{"$ref":"#/components/schemas/WorkflowStepInput"},"type":{"type":"string","enum":["filter"]},"condition":{"type":"string","description":"JS expression in a 'filter' step that returns `true` or `false` to indicate if execution should proceed"}},"required":["type","condition"]},"WorkflowUniquenessFilter":{"title":"Workflow Uniqueness Filter","type":"object","additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/WorkflowStepName"},"input":{"$ref":"#/components/schemas/WorkflowStepInput"},"type":{"type":"string","enum":["unique"]},"criteria":{"type":"string","description":"JS expression in a 'unique' step that returns a key used to identify object uniquenss"}},"required":["type","criteria"]},"WorkflowAction":{"title":"Workflow Action","type":"object","additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/WorkflowStepName"},"input":{"$ref":"#/components/schemas/WorkflowStepInput"},"type":{"type":"string","enum":["action"]},"action":{"type":"string","description":"ID of the Open API endpoint to execute. Base64 encoded JSON object containing endpint properties `{ method, path }`"}},"required":["type","action"]},"WorkflowRequest":{"title":"Workflow Request","type":"object","additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/WorkflowStepName"},"input":{"$ref":"#/components/schemas/WorkflowStepInput"},"type":{"type":"string","enum":["request"]},"method":{"type":"string","enum":["get","list","post","put","patch","delete","head","options"]},"url":{"type":"string"},"headers":{"type":"object","additionalProperties":{"type":"string"}}},"required":["type","method","url"]},"WorkflowSteps":{"title":"Workflow Steps","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/WorkflowMapping"},{"$ref":"#/components/schemas/WorkflowFilter"},{"$ref":"#/components/schemas/WorkflowUniquenessFilter"},{"$ref":"#/components/schemas/WorkflowAction"},{"$ref":"#/components/schemas/WorkflowRequest"}]},"example":[{"type":"filter","condition":"selectedAssetId !== '' && receiverId !== ''"},{"type":"map","mapping":{"map":{"assetId":"selectedAssetId","body":{"map":{"receiverId":"receiverId","qty":"1","destinationId":"null","price":"0","priceCurrency":"'USD'"}}}}},{"type":"action","action":"eyJwYXRoIjoiL2Fzc2V0cy97YXNzZXRJZH0vdHJhbnNmZXJzIiwibWV0aG9kIjoicG9zdCJ9"}]},"Mapping":{"type":"object","properties":{"from":{"type":"string","description":"Context source to map data from"},"forEach":{"type":"string","description":"Array context source to map data from"},"map":{"type":"object","description":"Object fields mapping"}},"additionalProperties":true,"example":{"map":{"outputField":"inputField"}}},"JsonSchema":{"title":"JSON Schema","description":"https://json-schema.org/draft-07/schema#","type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["array","boolean","integer","null","number","object","string"],"example":"object"},"required":{"type":"array","items":{"type":"string"},"uniqueItems":true},"additionalProperties":{"oneOf":[{"type":"boolean"},{"type":"object"}]},"properties":{"type":"object"}},"example":{"type":"object","properties":{"field1":{"type":"string"}},"required":["field1"],"additionalProperties":false}},"SmartContractTrigger":{"type":"object","properties":{"id":{"type":"string","description":"Unique trigger identifier","readOnly":true},"title":{"type":"string","description":"Custom title"}}},"SmartContractAction":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"title":{"type":"string"},"groups":{"type":"array","items":{"type":"string"},"uniqueItems":true},"description":{"type":"string"}},"required":["title","groups"]},"DataProcessor":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","description":"Data processor title"},"description":{"type":["string","null"]},"sample":{"oneOf":[{"$ref":"#/components/schemas/Attachment"},{"type":"null"}]},"workflow":{"type":"object","additionalProperties":false,"properties":{"parser":{"oneOf":[{"$ref":"#/components/schemas/DataProcessorXlsxParser"},{"$ref":"#/components/schemas/DataProcessorCsvParser"}]},"steps":{"$ref":"#/components/schemas/WorkflowSteps"}},"required":["parser","steps"]},"ownerId":{"type":"string","readOnly":true}}},"DataProcessorXlsxParser":{"type":"object","title":"XLSX Parser Configuration","additionalProperties":false,"properties":{"type":{"type":"string","enum":["xlsx"]},"config":{"type":"object","additionalProperties":false,"properties":{"sheetNamingPattern":{"type":"string","enum":["js-safe","original","indexes"],"default":"js-safe"},"defaultSheet":{"type":"string"},"ignoreHidden":{"type":"boolean","default":true},"ignoreHiddenRows":{"type":"boolean","default":true},"ignoreHiddenColumns":{"type":"boolean","default":true},"ignoreHiddenTabs":{"type":"boolean","default":true},"ignoreBlank":{"type":"boolean","default":true},"linesToSkip":{"type":"number","default":0},"timeForChunk":{"type":"number"},"containsHeader":{"type":"boolean","default":true},"parseDirection":{"type":"string","enum":["top-to-bottom","left-to-right"]},"schema":{"$ref":"#/components/schemas/JsonSchema"},"sheets":{"type":"object","additionalProperties":{"type":"object","additionalProperties":false,"properties":{"linesToSkip":{"type":"number","default":0},"containsHeader":{"type":"boolean","default":true},"parseDirection":{"type":"string","enum":["top-to-bottom","left-to-right"]},"schema":{"$ref":"#/components/schemas/JsonSchema"}}}}}}},"required":["type","config"]},"DataProcessorCsvParser":{"type":"object","title":"CSV Parser Configuration","additionalProperties":false,"properties":{"type":{"type":"string","enum":["csv"]},"config":{"type":"object","properties":{"linesToSkip":{"type":"number","default":0},"timeForChunk":{"type":"number","default":20},"containsHeader":{"type":"boolean","default":true},"parseDirection":{"type":"string","enum":["top-to-bottom","left-to-right"]},"schema":{"$ref":"#/components/schemas/JsonSchema"},"separator":{"type":"string"}}}},"required":["type","config"]},"DataProcessorResult":{"type":"object","properties":{"items":{"type":"number","description":"Total items in the main input array"},"processed":{"type":"number","description":"Total items processed"},"stats":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","title":"Step Name"},"input":{"type":"string","title":"Step Source Name"},"count":{"type":"number","title":"Step Successful Executions Number"},"errors":{"type":"object","title":"Step Execution Failures","properties":{"total":{"type":"number"},"groups":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"source":{"type":"object"},"total":{"type":"number"}}}}}}}}}}}}}},"ValidationWorkflowSummary":{"type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/ImmutableId"},"title":{"type":"string","description":"Validation workflow title","readOnly":true},"description":{"type":"string","description":"Validation workflow description","readOnly":true},"ownerId":{"type":"string","readOnly":true},"owner":{"type":"object","readOnly":true,"properties":{"id":{"type":"string","readOnly":true},"displayName":{"type":"string","readOnly":true}}}},"required":["title"]},"ValidationWorkflowDetails":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","description":"Validation workflow title"},"description":{"type":"string","description":"Validation workflow description"},"authToken":{"type":"string","description":"Optional auth token to use for workflow authentication. Write-only property"},"authTokenSig":{"type":"string","description":"Signature of the stored auth token for its presence and uniqueness validation","readOnly":true},"workflow":{"type":"object","additionalProperties":false,"properties":{"validatedActionId":{"type":"string"},"steps":{"$ref":"#/components/schemas/WorkflowSteps"}},"required":["validatedActionId","steps"]},"ownerId":{"type":"string","readOnly":true},"authenticatedAs":{"type":"object","description":"Display name of identity & account under which workflow runs with provided authToken","readOnly":true,"properties":{"user":{"type":"string","description":"User display name","readOnly":true},"account":{"type":"string","description":"Account display name","readOnly":true}}}},"required":["title","workflow"]},"TutorialStep":{"type":"object","required":["page","optional","popover"],"properties":{"page":{"type":"string"},"element":{"type":"string"},"optional":{"type":"boolean"},"onHover":{"type":"string"},"popover":{"type":"object","properties":{"title":{"$ref":"#/components/schemas/LocalizedString"},"description":{"$ref":"#/components/schemas/LocalizedString"},"position":{"type":"string"}}}}}},"responses":{"201":{"description":"HTTP 201 - Created","headers":{"Location":{"schema":{"type":"string"},"description":"Url of the created entity"}}},"202":{"description":"HTTP 202 - Accepted \nThe request has been accepted for processing, but the processing has not been completed."},"204":{"description":"HTTP 204 - No Content \nThe request has been processed, but no content will be provided in response"},"400":{"description":"HTTP 400 - Bad Request \nThe request is formatted incorrectly, most likely some of the required parameters are missed"},"401":{"description":"HTTP 401 - Unauthorized \nUser is not authenticated or session has expired"},"403":{"description":"HTTP 403 - Forbidden \nNot authorized to access selected resource"},"404":{"description":"HTTP 404 - Not Found \nRequested resource could not be found"},"409":{"description":"HTTP 409 - Conflict \nThe request could not be completed due to a conflict with the current state of the target resource"},"422":{"description":"HTTP 422 - Unprocessable Request \nThe server understands the content type of the request entity and the syntax of the request is correct, but was unable to process the contained instructions"},"429":{"description":"HTTP 429 - Too Many Requests \nThe user has sent too many requests in a given amount of time (\"rate limiting\")."},"NewProfileTimestamp":{"description":"HTTP 200 - Profile modification successful","content":{"application/json":{"schema":{"type":"object","properties":{"lastModified":{"type":"number","description":"If profile was modified, contains new `lastModified` timestamp","example":1568894551000}}}}}}}},"security":[{"Bearer":[]}]}