{"items":[{"type":"link","label":"Jiko Customer API","link":"/products/customer-api/reference","routeSlug":"/products/customer-api/reference","content":{"contentType":"overview","meta":{"name":"Jiko Customer API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"reference.json","url":"/_bundle/products/customer-api/reference.json?download"},{"kind":"download","label":"reference.yaml","url":"/_bundle/products/customer-api/reference.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Jiko Customer API (Version: d28453d9)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/products/customer-api/reference"}],"sectionId":"/products/customer-api/reference"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/introduction"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Introduction"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Welcome to the Jiko Customer API Reference! Jiko enables you to integrate money storage and movement, backed by the safety and security of US Treasury Bills. Use the Customer API if you are a Jiko customer integrating Jiko directly into your internal systems."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For questions regarding authorization for the Customer API, please visit "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/customer-api/guides/oauth/getting-started"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"our OAuth guide"},"children":[]}]}]}]}]}]}],"sectionId":"/products/customer-api/reference/section/introduction"}]}]}},{"type":"link","label":"Introduction","link":"/products/customer-api/reference/section/introduction","routeSlug":"/products/customer-api/reference/section/introduction","content":null},{"type":"separator","label":"Pockets","content":null},{"type":"group","label":"Pockets","link":"/products/customer-api/reference/pockets","routeSlug":"/products/customer-api/reference/pockets","items":[{"label":"List Customer Pockets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/pockets/list_customer_pockets_api_v2_pockets__get","routeSlug":"/products/customer-api/reference/pockets/list_customer_pockets_api_v2_pockets__get","metadata":{"seo":{"title":"List Customer Pockets","description":"This endpoint lists all the pockets for a given customer. It returns a Pockets object which is a paginated list of Pocket objects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_customer_pockets_api_v2_pockets__get","name":"List Customer Pockets","isWebhook":false,"pointer":"/paths/~1api~1v2~1pockets~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Customer Pockets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists all the pockets for a given customer. It returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pockets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object which is a paginated list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pocket"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["pockets.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_222"},{"name":"limit","in":"query","schemaId":"schema_223"},{"name":"valuation_type","in":"query","schemaId":"schema_224"},{"name":"status[]","in":"query","schemaId":"schema_225"},{"name":"omit[]","in":"query","schemaId":"schema_226"}],"pointer":"/paths/~1api~1v2~1pockets~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/pockets/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_222"},{"name":"limit","in":"query","required":false,"schemaId":"schema_223"},{"name":"valuation_type","in":"query","required":false,"schemaId":"schema_224"},{"name":"status[]","in":"query","required":false,"schemaId":"schema_225"},{"name":"omit[]","in":"query","required":false,"schemaId":"schema_226"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["pockets.read"]}],"responseCodes":["200","422"],"pointer":"/api/v2/pockets/","href":"pockets/list_customer_pockets_api_v2_pockets__get","openApiOperationId":"list_customer_pockets_api_v2_pockets__get","summary":"List Customer Pockets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pockets"}},"schemaId":"components/schemas/Pockets"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1pockets~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Pockets","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pockets"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pockets/list_customer_pockets_api_v2_pockets__get"}],"panels":[]}]},"httpPath":"/api/v2/pockets/"},{"label":"Create Customer Pocket","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/pockets/create_customer_pocket_api_v2_pockets__post","routeSlug":"/products/customer-api/reference/pockets/create_customer_pocket_api_v2_pockets__post","metadata":{"seo":{"title":"Create Customer Pocket","description":"This endpoint creates a new pocket for a customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_customer_pocket_api_v2_pockets__post","name":"Create Customer Pocket","isWebhook":false,"pointer":"/paths/~1api~1v2~1pockets~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Customer Pocket","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint creates a new pocket for a customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body requires a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreatePocketRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, specifying the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trading_strategy_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pocket_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It returns the newly created "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pocket"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["pockets.write"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePocketRequest"}},"schemaId":"components/schemas/CreatePocketRequest","pointer":"/paths/~1api~1v2~1pockets~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/pockets/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["pockets.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePocketRequest"}},"responseCodes":["200","422"],"pointer":"/api/v2/pockets/","href":"pockets/create_customer_pocket_api_v2_pockets__post","openApiOperationId":"create_customer_pocket_api_v2_pockets__post","summary":"Create Customer Pocket"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"schemaId":"components/schemas/CreatePocketRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePocketRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pocket"}},"schemaId":"components/schemas/Pocket"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1pockets~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Pocket","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pocket"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pockets/create_customer_pocket_api_v2_pockets__post"}],"panels":[]}]},"httpPath":"/api/v2/pockets/"},{"label":"Get Customer Pocket","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/pockets/get_customer_pocket_api_v2_pockets__pocket_id___get","routeSlug":"/products/customer-api/reference/pockets/get_customer_pocket_api_v2_pockets__pocket_id___get","metadata":{"seo":{"title":"Get Customer Pocket","description":"This endpoint retrieves the details of a specific pocket, and returns a Pocket object with detailed portfolio information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_customer_pocket_api_v2_pockets__pocket_id___get","name":"Get Customer Pocket","isWebhook":false,"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Customer Pocket","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves the details of a specific pocket, and returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pocket"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object with detailed portfolio information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["pockets.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pocket_id","in":"path","schemaId":"schema_227","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"valuation_type","in":"query","schemaId":"schema_224"},{"name":"omit[]","in":"query","schemaId":"schema_226"}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/pockets/{pocket_id}/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"pocket_id","in":"path","required":true,"schemaId":"schema_227"}],"query":[{"name":"valuation_type","in":"query","required":false,"schemaId":"schema_224"},{"name":"omit[]","in":"query","required":false,"schemaId":"schema_226"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["pockets.read"]}],"responseCodes":["200","422"],"pointer":"/api/v2/pockets/{pocket_id}/","href":"pockets/get_customer_pocket_api_v2_pockets__pocket_id___get","openApiOperationId":"get_customer_pocket_api_v2_pockets__pocket_id___get","summary":"Get Customer Pocket"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerPocket"}},"schemaId":"components/schemas/CustomerPocket"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerPocket","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerPocket"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pockets/get_customer_pocket_api_v2_pockets__pocket_id___get"}],"panels":[]}]},"httpPath":"/api/v2/pockets/{pocket_id}/"},{"label":"Update Pocket","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/pockets/update_pocket_api_v2_pockets__pocket_id___patch","routeSlug":"/products/customer-api/reference/pockets/update_pocket_api_v2_pockets__pocket_id___patch","metadata":{"seo":{"title":"Update Pocket","description":"This endpoint updates a pocket's information, such as its name or status (e.g., closing a pocket).If the intent is to close a pocket, then there are two requirements: The pocket needs to be empty,and there has to be at least one other open pocket belonging to the customer. Additionally,when you close a pocket, you also need to pass a closure_reason along with the status update."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_pocket_api_v2_pockets__pocket_id___patch","name":"Update Pocket","isWebhook":false,"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Pocket","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint updates a pocket's information, such as its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., closing a pocket)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the intent is to close a pocket, then there are two requirements: The pocket needs to be empty,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and there has to be at least one other open pocket belonging to the customer. Additionally,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when you close a pocket, you also need to pass a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closure_reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" along with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" update."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body requires an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdatePocketRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object. It returns the updated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pocket"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["pockets.write","pockets.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pocket_id","in":"path","schemaId":"schema_227","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePocketRequest"}},"schemaId":"components/schemas/UpdatePocketRequest","pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v2/pockets/{pocket_id}/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"pocket_id","in":"path","required":true,"schemaId":"schema_227"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["pockets.write","pockets.read"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdatePocketRequest"}},"responseCodes":["200","422"],"pointer":"/api/v2/pockets/{pocket_id}/","href":"pockets/update_pocket_api_v2_pockets__pocket_id___patch","openApiOperationId":"update_pocket_api_v2_pockets__pocket_id___patch","summary":"Update Pocket"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"schemaId":"components/schemas/UpdatePocketRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePocketRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pocket"}},"schemaId":"components/schemas/Pocket"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Pocket","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pocket"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pockets/update_pocket_api_v2_pockets__pocket_id___patch"}],"panels":[]}]},"httpPath":"/api/v2/pockets/{pocket_id}/"},{"label":"Get Customer Earnings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/pockets/get-customer-earnings-v2","routeSlug":"/products/customer-api/reference/pockets/get-customer-earnings-v2","metadata":{"seo":{"title":"Get Customer Earnings","description":"This endpoint returns current-period earnings for the customer's pockets in a single call: one entry per pocket plus their exact aggregate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-customer-earnings-v2","name":"Get Customer Earnings","isWebhook":false,"pointer":"/paths/~1api~1v2~1earnings~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Customer Earnings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns current-period earnings for the customer's pockets in a single call: one entry per pocket plus their exact aggregate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aggregate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the field-wise sum of the per-pocket entries (sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"earnings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appreciation_per_second"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", earliest "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricing_timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), so it always matches the total of the individual rows. It is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only when no pockets match the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-defined ranges are defined as such:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ytd (Year-to-date) From January 1st of the current year"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mtd (Month-to-date) From the 1st calendar day of the current month, or start of business that month"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wtd (Week-to-date) From the most recent Monday, or start of business that week."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all-time (default) From Account start"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All through to the current day if business day, or last business day."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom date ranges are not supported here; use the single-pocket earnings endpoint with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period=range"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default every pocket that is not closed is included, up to at most 30 per request — requests covering more pockets are rejected with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pocket_id[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter to restrict the earnings to specific pockets; a closed pocket's earnings are included only when it is listed there explicitly."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["pockets.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"period","in":"query","schemaId":"schema_228","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period to fetch earnings for. Can be one of"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ytd (Year-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mtd (Month-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wtd (Week-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all-time"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom date ranges are not supported at the customer level; use the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single-pocket earnings endpoint with 'range' instead."},"children":[]}]}]}]},{"name":"pocket_id[]","in":"query","schemaId":"schema_229","description":"Restricts the earnings to the given pockets. Defaults to all of the customer's pockets except closed ones; a closed pocket's earnings are included only when it is listed here explicitly."}],"pointer":"/paths/~1api~1v2~1earnings~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/earnings/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"period","in":"query","required":false,"schemaId":"schema_228"},{"name":"pocket_id[]","in":"query","required":false,"schemaId":"schema_229"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["pockets.read"]}],"responseCodes":["200","422"],"pointer":"/api/v2/earnings/","href":"pockets/get-customer-earnings-v2","openApiOperationId":"get-customer-earnings-v2","summary":"Get Customer Earnings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerEarningsResponse"}},"schemaId":"components/schemas/CustomerEarningsResponse"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1earnings~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerEarningsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerEarningsResponse"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pockets/get-customer-earnings-v2"}],"panels":[]}]},"httpPath":"/api/v2/earnings/"},{"label":"Get Single Pocket Earnings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/pockets/get_single_pocket_earnings_api_v2_pockets__pocket_id__earnings__get","routeSlug":"/products/customer-api/reference/pockets/get_single_pocket_earnings_api_v2_pockets__pocket_id__earnings__get","metadata":{"seo":{"title":"Get Single Pocket Earnings","description":"This endpoint returns pocket earnings for a single pocket for a specified datetime period."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_single_pocket_earnings_api_v2_pockets__pocket_id__earnings__get","name":"Get Single Pocket Earnings","isWebhook":false,"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1earnings~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Single Pocket Earnings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns pocket earnings for a single pocket for a specified datetime period."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optionally pre-defined ranges are defined as such:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ytd (Year-to-date) From January 1st of the current year"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mtd (Month-to-date) From the 1st calendar day of the current month, or start of business that month"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wtd (Week-to-date) From the most recent Monday, or start of business that week."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all-time (default) From Account start"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All through to the current day if business day, or last business day."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is chosen, you need to specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date_from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (inclusive)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["pockets.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pocket_id","in":"path","schemaId":"schema_230","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1earnings~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"period","in":"query","schemaId":"schema_231","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period to fetch earnings for. Can be one of"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ytd (Year-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mtd (Month-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wtd (Week-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all-time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"range"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When 'range' is chosen, you need to specify 'date_from' and 'date_to' (inclusive)."},"children":[]}]}]}]},{"name":"date_from","in":"query","schemaId":"schema_232"},{"name":"date_to","in":"query","schemaId":"schema_233"}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1earnings~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/pockets/{pocket_id}/earnings/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"pocket_id","in":"path","required":true,"schemaId":"schema_230"}],"query":[{"name":"period","in":"query","required":false,"schemaId":"schema_231"},{"name":"date_from","in":"query","required":false,"schemaId":"schema_232"},{"name":"date_to","in":"query","required":false,"schemaId":"schema_233"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["pockets.read"]}],"responseCodes":["200","422"],"pointer":"/api/v2/pockets/{pocket_id}/earnings/","href":"pockets/get_single_pocket_earnings_api_v2_pockets__pocket_id__earnings__get","openApiOperationId":"get_single_pocket_earnings_api_v2_pockets__pocket_id__earnings__get","summary":"Get Single Pocket Earnings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EarningsResponse"}},"schemaId":"components/schemas/EarningsResponse"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1earnings~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EarningsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EarningsResponse"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pockets/get_single_pocket_earnings_api_v2_pockets__pocket_id__earnings__get"}],"panels":[]}]},"httpPath":"/api/v2/pockets/{pocket_id}/earnings/"}],"content":{"contentType":"group","meta":{"name":"Pockets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pockets","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to view Pocket information. Jiko Pockets consist of a bank account and a brokerage account. When funds are deposited into a Pocket, they're immediately invested in T-bills."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/pockets/","summary":"List Customer Pockets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pockets/list_customer_pockets_api_v2_pockets__get","deprecated":false},{"title":"/api/v2/pockets/","summary":"Create Customer Pocket","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pockets/create_customer_pocket_api_v2_pockets__post","deprecated":false},{"title":"/api/v2/pockets/{pocket_id}/","summary":"Get Customer Pocket","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pockets/get_customer_pocket_api_v2_pockets__pocket_id___get","deprecated":false},{"title":"/api/v2/pockets/{pocket_id}/","summary":"Update Pocket","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/pockets/update_pocket_api_v2_pockets__pocket_id___patch","deprecated":false},{"title":"/api/v2/earnings/","summary":"Get Customer Earnings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pockets/get-customer-earnings-v2","deprecated":false},{"title":"/api/v2/pockets/{pocket_id}/earnings/","summary":"Get Single Pocket Earnings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pockets/get_single_pocket_earnings_api_v2_pockets__pocket_id__earnings__get","deprecated":false}]}]}]}]}},{"type":"group","label":"Portals","link":"/products/customer-api/reference/portals","routeSlug":"/products/customer-api/reference/portals","items":[{"label":"List Pocket Portals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/portals/list-pocket-portals-v2","routeSlug":"/products/customer-api/reference/portals/list-pocket-portals-v2","metadata":{"seo":{"title":"List Pocket Portals","description":"This endpoint lists the payment portals associated with a specific Jiko pocket ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-pocket-portals-v2","name":"List Pocket Portals","isWebhook":false,"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Pocket Portals","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists the payment portals associated with a specific Jiko pocket ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PortalListResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object containing a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["pockets.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pocket_id","in":"path","schemaId":"schema_227","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type[]","in":"query","schemaId":"schema_234"},{"name":"status[]","in":"query","schemaId":"schema_235"},{"name":"cursor","in":"query","schemaId":"schema_236"},{"name":"limit","in":"query","schemaId":"schema_237"}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/pockets/{pocket_id}/portals/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"pocket_id","in":"path","required":true,"schemaId":"schema_227"}],"query":[{"name":"type[]","in":"query","required":false,"schemaId":"schema_234"},{"name":"status[]","in":"query","required":false,"schemaId":"schema_235"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_236"},{"name":"limit","in":"query","required":false,"schemaId":"schema_237"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["pockets.read"]}],"responseCodes":["200","404","422"],"pointer":"/api/v2/pockets/{pocket_id}/portals/","href":"portals/list-pocket-portals-v2","openApiOperationId":"list-pocket-portals-v2","summary":"List Pocket Portals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortalListResponse"}},"schemaId":"components/schemas/PortalListResponse"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PortalListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortalListResponse"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portals/list-pocket-portals-v2"}],"panels":[]}]},"httpPath":"/api/v2/pockets/{pocket_id}/portals/"},{"label":"Create Pocket Portal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/portals/create-pocket-portal","routeSlug":"/products/customer-api/reference/portals/create-pocket-portal","metadata":{"seo":{"title":"Create Pocket Portal","description":"This endpoint creates a new portal for a customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-pocket-portal","name":"Create Pocket Portal","isWebhook":false,"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Pocket Portal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint creates a new portal for a customer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["pockets.write","pockets.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pocket_id","in":"path","schemaId":"schema_227","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_238"}},"schemaId":"schema_238","pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/pockets/{pocket_id}/portals/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"pocket_id","in":"path","required":true,"schemaId":"schema_227"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["pockets.write","pockets.read"]}],"requestBody":{"application/json":{"schemaId":"schema_238"}},"responseCodes":["201","404","422"],"pointer":"/api/v2/pockets/{pocket_id}/portals/","href":"portals/create-pocket-portal","openApiOperationId":"create-pocket-portal","summary":"Create Pocket Portal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"schemaId":"schema_238","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_238"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortalType"}},"schemaId":"components/schemas/PortalType"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PortalType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortalType"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portals/create-pocket-portal"}],"panels":[]}]},"httpPath":"/api/v2/pockets/{pocket_id}/portals/"},{"label":"List Customer Portals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/portals/list-customer-portals-v2","routeSlug":"/products/customer-api/reference/portals/list-customer-portals-v2","metadata":{"seo":{"title":"List Customer Portals","description":"This endpoint lists all portals for the customer. It returns a PortalListResponse object containing a list of Portal objects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-customer-portals-v2","name":"List Customer Portals","isWebhook":false,"pointer":"/paths/~1api~1v2~1portals~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Customer Portals","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists all portals for the customer. It returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PortalListResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object containing a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Portal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["pockets.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type[]","in":"query","schemaId":"schema_234"},{"name":"status[]","in":"query","schemaId":"schema_235"},{"name":"cursor","in":"query","schemaId":"schema_236"},{"name":"limit","in":"query","schemaId":"schema_237"}],"pointer":"/paths/~1api~1v2~1portals~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/portals/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"type[]","in":"query","required":false,"schemaId":"schema_234"},{"name":"status[]","in":"query","required":false,"schemaId":"schema_235"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_236"},{"name":"limit","in":"query","required":false,"schemaId":"schema_237"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["pockets.read"]}],"responseCodes":["200","404","422"],"pointer":"/api/v2/portals/","href":"portals/list-customer-portals-v2","openApiOperationId":"list-customer-portals-v2","summary":"List Customer Portals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortalListResponse"}},"schemaId":"components/schemas/PortalListResponse"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1portals~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PortalListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortalListResponse"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portals/list-customer-portals-v2"}],"panels":[]}]},"httpPath":"/api/v2/portals/"},{"label":"Get Funding Instructions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/portals/get-funding-instructions","routeSlug":"/products/customer-api/reference/portals/get-funding-instructions","metadata":{"seo":{"title":"Get Funding Instructions","description":"Get Funding Instructions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-funding-instructions","name":"Get Funding Instructions","isWebhook":false,"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1funding-instructions~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Funding Instructions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["pockets.read","customer.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pocket_id","in":"path","schemaId":"schema_227","required":true},{"name":"portal_id","in":"path","schemaId":"schema_239","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1funding-instructions~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/funding-instructions/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"pocket_id","in":"path","required":true,"schemaId":"schema_227"},{"name":"portal_id","in":"path","required":true,"schemaId":"schema_239"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["pockets.read","customer.read"]}],"responseCodes":["200","404","422"],"pointer":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/funding-instructions/","href":"portals/get-funding-instructions","openApiOperationId":"get-funding-instructions","summary":"Get Funding Instructions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FundingInstructionsResponse"}},"schemaId":"components/schemas/FundingInstructionsResponse"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1funding-instructions~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FundingInstructionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FundingInstructionsResponse"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portals/get-funding-instructions"}],"panels":[]}]},"httpPath":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/funding-instructions/"},{"label":"Update Pocket Portal","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/portals/update-pocket-portal","routeSlug":"/products/customer-api/reference/portals/update-pocket-portal","metadata":{"seo":{"title":"Update Pocket Portal","description":"This endpoint updates a portal's name, or closes it by setting its status to CLOSED."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update-pocket-portal","name":"Update Pocket Portal","isWebhook":false,"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Pocket Portal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint updates a portal's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or closes it by setting its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLOSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Closing a portal is irreversible; the only accepted value for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLOSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204 No Content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on success."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["pockets.write","pockets.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pocket_id","in":"path","schemaId":"schema_227","required":true},{"name":"portal_id","in":"path","schemaId":"schema_239","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortalUpdateRequest"}},"schemaId":"components/schemas/PortalUpdateRequest","pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"pocket_id","in":"path","required":true,"schemaId":"schema_227"},{"name":"portal_id","in":"path","required":true,"schemaId":"schema_239"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["pockets.write","pockets.read"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PortalUpdateRequest"}},"responseCodes":["204","404","422"],"pointer":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/","href":"portals/update-pocket-portal","openApiOperationId":"update-pocket-portal","summary":"Update Pocket Portal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"schemaId":"components/schemas/PortalUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortalUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful Response"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portals/update-pocket-portal"}],"panels":[]}]},"httpPath":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/"}],"content":{"contentType":"group","meta":{"name":"Portals"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Portals","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to create and view Portals. Portals allow third-party financial institutions to initiate ACH and wire transfers. A Portal consists of a routing and an account number. Multiple Portals can be created for a single Pocket."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/pockets/{pocket_id}/portals/","summary":"List Pocket Portals","prefix":{"name":"get","color":"get"},"badges":[],"link":"/portals/list-pocket-portals-v2","deprecated":false},{"title":"/api/v2/pockets/{pocket_id}/portals/","summary":"Create Pocket Portal","prefix":{"name":"post","color":"post"},"badges":[],"link":"/portals/create-pocket-portal","deprecated":false},{"title":"/api/v2/portals/","summary":"List Customer Portals","prefix":{"name":"get","color":"get"},"badges":[],"link":"/portals/list-customer-portals-v2","deprecated":false},{"title":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/funding-instructions/","summary":"Get Funding Instructions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/portals/get-funding-instructions","deprecated":false},{"title":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/","summary":"Update Pocket Portal","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/portals/update-pocket-portal","deprecated":false}]}]}]}]}},{"type":"separator","label":"Transactions","content":null},{"type":"group","label":"Transactions","link":"/products/customer-api/reference/transactions","routeSlug":"/products/customer-api/reference/transactions","items":[{"label":"List Transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/transactions/list-transactions-v2","routeSlug":"/products/customer-api/reference/transactions/list-transactions-v2","metadata":{"seo":{"title":"List Transactions","description":"This endpoint lists all transactions for a customer's pockets. It provides a comprehensive view of all financial activities."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-transactions-v2","name":"List Transactions","isWebhook":false,"pointer":"/paths/~1api~1v2~1transactions~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists all transactions for a customer's pockets. It provides a comprehensive view of all financial activities."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It returns a paginated list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects, which can be of various types ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WIRE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc.)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It does not include transactions between the bank account and brokerage account."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["pockets.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_236"},{"name":"limit","in":"query","schemaId":"schema_240"},{"name":"order","in":"query","schemaId":"schema_241"},{"name":"pocket[]","in":"query","schemaId":"schema_242"},{"name":"portal[]","in":"query","schemaId":"schema_243"},{"name":"card[]","in":"query","schemaId":"schema_244"},{"name":"type[]","in":"query","schemaId":"schema_245"},{"name":"on_us_transfer[]","in":"query","schemaId":"schema_246"},{"name":"wire[]","in":"query","schemaId":"schema_247"},{"name":"time_booked_from","in":"query","schemaId":"schema_248"},{"name":"time_booked_to","in":"query","schemaId":"schema_249"},{"name":"amount_to","in":"query","schemaId":"schema_250"},{"name":"amount_from","in":"query","schemaId":"schema_251"},{"name":"direction","in":"query","schemaId":"schema_252"}],"pointer":"/paths/~1api~1v2~1transactions~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/transactions/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_236"},{"name":"limit","in":"query","required":false,"schemaId":"schema_240"},{"name":"order","in":"query","required":false,"schemaId":"schema_241"},{"name":"pocket[]","in":"query","required":false,"schemaId":"schema_242"},{"name":"portal[]","in":"query","required":false,"schemaId":"schema_243"},{"name":"card[]","in":"query","required":false,"schemaId":"schema_244"},{"name":"type[]","in":"query","required":false,"schemaId":"schema_245"},{"name":"on_us_transfer[]","in":"query","required":false,"schemaId":"schema_246"},{"name":"wire[]","in":"query","required":false,"schemaId":"schema_247"},{"name":"time_booked_from","in":"query","required":false,"schemaId":"schema_248"},{"name":"time_booked_to","in":"query","required":false,"schemaId":"schema_249"},{"name":"amount_to","in":"query","required":false,"schemaId":"schema_250"},{"name":"amount_from","in":"query","required":false,"schemaId":"schema_251"},{"name":"direction","in":"query","required":false,"schemaId":"schema_252"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["pockets.read"]}],"responseCodes":["200","404","422"],"pointer":"/api/v2/transactions/","href":"transactions/list-transactions-v2","openApiOperationId":"list-transactions-v2","summary":"List Transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorListResponse_Annotated_Union_ACHTransactionActivity__WireTransactionActivity__CardTransactionActivity__OnUsTransactionActivity__FeeTransactionActivity__CreditTransactionActivity__GenericTransactionActivity__OnChainTransactionActivity___FieldInfo_annotation_NoneType__required_True__discriminator__type____"}},"schemaId":"components/schemas/CursorListResponse_Annotated_Union_ACHTransactionActivity__WireTransactionActivity__CardTransactionActivity__OnUsTransactionActivity__FeeTransactionActivity__CreditTransactionActivity__GenericTransactionActivity__OnChainTransactionActivity___FieldInfo_annotation_NoneType__required_True__discriminator__type____"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1transactions~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorListResponse_Annotated_Union_ACHTransactionActivity__WireTransactionActivity__CardTransactionActivity__OnUsTransactionActivity__FeeTransactionActivity__CreditTransactionActivity__GenericTransactionActivity__OnChainTransactionActivity___FieldInfo_annotation_NoneType__required_True__discriminator__type____","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorListResponse_Annotated_Union_ACHTransactionActivity__WireTransactionActivity__CardTransactionActivity__OnUsTransactionActivity__FeeTransactionActivity__CreditTransactionActivity__GenericTransactionActivity__OnChainTransactionActivity___FieldInfo_annotation_NoneType__required_True__discriminator__type____"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/list-transactions-v2"}],"panels":[]}]},"httpPath":"/api/v2/transactions/"},{"label":"Transactions As CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/transactions/transactions_as_csv_api_v2_transactions_csv_get","routeSlug":"/products/customer-api/reference/transactions/transactions_as_csv_api_v2_transactions_csv_get","metadata":{"seo":{"title":"Transactions As CSV","description":"This endpoint downloads a customer's transaction history in CSV format. This is useful for accounting and reconciliation purposes, and can be filtered by pocket, transaction type, and a time range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transactions_as_csv_api_v2_transactions_csv_get","name":"Transactions As CSV","isWebhook":false,"pointer":"/paths/~1api~1v2~1transactions.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transactions As CSV","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint downloads a customer's transaction history in CSV format. This is useful for accounting and reconciliation purposes, and can be filtered by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pocket"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", transaction "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and a time range."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["pockets.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pocket[]","in":"query","schemaId":"schema_242"},{"name":"type[]","in":"query","schemaId":"schema_245"},{"name":"time_booked_from","in":"query","schemaId":"schema_248"},{"name":"time_booked_to","in":"query","schemaId":"schema_249"}],"pointer":"/paths/~1api~1v2~1transactions.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/transactions.csv","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"pocket[]","in":"query","required":false,"schemaId":"schema_242"},{"name":"type[]","in":"query","required":false,"schemaId":"schema_245"},{"name":"time_booked_from","in":"query","required":false,"schemaId":"schema_248"},{"name":"time_booked_to","in":"query","required":false,"schemaId":"schema_249"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["pockets.read"]}],"responseCodes":["200","404","422"],"pointer":"/api/v2/transactions.csv","href":"transactions/transactions_as_csv_api_v2_transactions_csv_get","openApiOperationId":"transactions_as_csv_api_v2_transactions_csv_get","summary":"Transactions As CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1transactions.csv/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/transactions_as_csv_api_v2_transactions_csv_get"}],"panels":[]}]},"httpPath":"/api/v2/transactions.csv"}],"content":{"contentType":"group","meta":{"name":"Transactions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transactions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these endpoints to view Transactions of funds moving in and out of Jiko Pockets, specifically the bank account component (cash deposits and withdrawals). For viewing information regarding the brokerage account component (buying and selling of T-bills), use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Trades"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/transactions/","summary":"List Transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/list-transactions-v2","deprecated":false},{"title":"/api/v2/transactions.csv","summary":"Transactions As CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/transactions_as_csv_api_v2_transactions_csv_get","deprecated":false}]}]}]}]}},{"type":"separator","label":"Trades","content":null},{"type":"group","label":"Trading Strategies","link":"/products/customer-api/reference/trading-strategies","routeSlug":"/products/customer-api/reference/trading-strategies","items":[{"label":"List Trading Strategies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/trading-strategies/list_trading_strategies_api_v2_trading_strategies__get","routeSlug":"/products/customer-api/reference/trading-strategies/list_trading_strategies_api_v2_trading_strategies__get","metadata":{"seo":{"title":"List Trading Strategies","description":"This endpoint lists the available trading strategies that can be applied to a pocket. This is the modern replacement for \"pocket configurations.\""}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_trading_strategies_api_v2_trading_strategies__get","name":"List Trading Strategies","isWebhook":false,"pointer":"/paths/~1api~1v2~1trading-strategies~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Trading Strategies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists the available trading strategies that can be applied to a pocket. This is the modern replacement for \"pocket configurations.\""},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TradingStrategies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object. You can filter strategies by their applicability ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEPOSIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REINVESTMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint is preferred for use over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/pocket-configurations/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["pockets.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"applicable_to","in":"query","schemaId":"schema_253"}],"pointer":"/paths/~1api~1v2~1trading-strategies~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/trading-strategies/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"applicable_to","in":"query","required":false,"schemaId":"schema_253"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["pockets.read"]}],"responseCodes":["200","422"],"pointer":"/api/v2/trading-strategies/","href":"trading-strategies/list_trading_strategies_api_v2_trading_strategies__get","openApiOperationId":"list_trading_strategies_api_v2_trading_strategies__get","summary":"List Trading Strategies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TradingStrategies"}},"schemaId":"components/schemas/TradingStrategies"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1trading-strategies~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TradingStrategies","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TradingStrategies"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trading-strategies/list_trading_strategies_api_v2_trading_strategies__get"}],"panels":[]}]},"httpPath":"/api/v2/trading-strategies/"}],"content":{"contentType":"group","meta":{"name":"Trading Strategies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trading Strategies","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to see available trading strategies applicable to a Pocket."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/trading-strategies/","summary":"List Trading Strategies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/trading-strategies/list_trading_strategies_api_v2_trading_strategies__get","deprecated":false}]}]}]}]}},{"type":"group","label":"Trades","link":"/products/customer-api/reference/trades","routeSlug":"/products/customer-api/reference/trades","items":[{"label":"List Trades","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/trades/list_trades_api_v1_trades__get","routeSlug":"/products/customer-api/reference/trades/list_trades_api_v1_trades__get","metadata":{"seo":{"title":"List Trades","description":"This endpoint lists all buy, sell, and maturity events for securities (T-bills) within the customer's accounts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_trades_api_v1_trades__get","name":"List Trades","isWebhook":false,"pointer":"/paths/~1api~1v1~1trades~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Trades","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists all buy, sell, and maturity events for securities (T-bills) within the customer's accounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TradeListResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The list can be filtered by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a trade datetime range."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["pockets.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"book_date_from","in":"query","schemaId":"schema_254","description":"Filters the resulting trade list by book date from the provided ISO8601 date, inclusively"},{"name":"book_date_to","in":"query","schemaId":"schema_255","description":"Filters the resulting trade list by book date to the provided ISO8601 date, inclusively"},{"name":"settlement_date_from","in":"query","schemaId":"schema_256","description":"Filters the resulting trade list by settlement date from the provided ISO8601 date, inclusively"},{"name":"settlement_date_to","in":"query","schemaId":"schema_257","description":"Filters the resulting trade list by settlement date to the provided ISO8601 date, inclusively"},{"name":"account[]","in":"query","schemaId":"schema_258"},{"name":"trade_datetime_from","in":"query","schemaId":"schema_259"},{"name":"trade_datetime_to","in":"query","schemaId":"schema_260"},{"name":"cursor","in":"query","schemaId":"schema_236"},{"name":"limit","in":"query","schemaId":"schema_240"}],"pointer":"/paths/~1api~1v1~1trades~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/trades/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"book_date_from","in":"query","required":false,"schemaId":"schema_254"},{"name":"book_date_to","in":"query","required":false,"schemaId":"schema_255"},{"name":"settlement_date_from","in":"query","required":false,"schemaId":"schema_256"},{"name":"settlement_date_to","in":"query","required":false,"schemaId":"schema_257"},{"name":"account[]","in":"query","required":false,"schemaId":"schema_258"},{"name":"trade_datetime_from","in":"query","required":false,"schemaId":"schema_259"},{"name":"trade_datetime_to","in":"query","required":false,"schemaId":"schema_260"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_236"},{"name":"limit","in":"query","required":false,"schemaId":"schema_240"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["pockets.read"]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/trades/","href":"trades/list_trades_api_v1_trades__get","openApiOperationId":"list_trades_api_v1_trades__get","summary":"List Trades"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TradeListResponse"}},"schemaId":"components/schemas/TradeListResponse"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1trades~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TradeListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TradeListResponse"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trades/list_trades_api_v1_trades__get"}],"panels":[]}]},"httpPath":"/api/v1/trades/"},{"label":"Trades As CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/trades/trades_as_csv_api_v1_trades_csv_get","routeSlug":"/products/customer-api/reference/trades/trades_as_csv_api_v1_trades_csv_get","metadata":{"seo":{"title":"Trades As CSV","description":"This endpoint downloads the customer's complete trade history as a CSV file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"trades_as_csv_api_v1_trades_csv_get","name":"Trades As CSV","isWebhook":false,"pointer":"/paths/~1api~1v1~1trades.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trades As CSV","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint downloads the customer's complete trade history as a CSV file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is useful for record-keeping and analysis and can be filtered by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a trade datetime range."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["pockets.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"book_date_from","in":"query","schemaId":"schema_254","description":"Filters the resulting trade list by book date from the provided ISO8601 date, inclusively"},{"name":"book_date_to","in":"query","schemaId":"schema_255","description":"Filters the resulting trade list by book date to the provided ISO8601 date, inclusively"},{"name":"settlement_date_from","in":"query","schemaId":"schema_256","description":"Filters the resulting trade list by settlement date from the provided ISO8601 date, inclusively"},{"name":"settlement_date_to","in":"query","schemaId":"schema_257","description":"Filters the resulting trade list by settlement date to the provided ISO8601 date, inclusively"},{"name":"account[]","in":"query","schemaId":"schema_258"},{"name":"trade_datetime_from","in":"query","schemaId":"schema_259"},{"name":"trade_datetime_to","in":"query","schemaId":"schema_260"}],"pointer":"/paths/~1api~1v1~1trades.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/trades.csv","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"book_date_from","in":"query","required":false,"schemaId":"schema_254"},{"name":"book_date_to","in":"query","required":false,"schemaId":"schema_255"},{"name":"settlement_date_from","in":"query","required":false,"schemaId":"schema_256"},{"name":"settlement_date_to","in":"query","required":false,"schemaId":"schema_257"},{"name":"account[]","in":"query","required":false,"schemaId":"schema_258"},{"name":"trade_datetime_from","in":"query","required":false,"schemaId":"schema_259"},{"name":"trade_datetime_to","in":"query","required":false,"schemaId":"schema_260"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["pockets.read"]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/trades.csv","href":"trades/trades_as_csv_api_v1_trades_csv_get","openApiOperationId":"trades_as_csv_api_v1_trades_csv_get","summary":"Trades As CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TradeListResponse"}},"schemaId":"components/schemas/TradeListResponse"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1trades.csv/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TradeListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TradeListResponse"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trades/trades_as_csv_api_v1_trades_csv_get"}],"panels":[]}]},"httpPath":"/api/v1/trades.csv"},{"label":"Download Trade Confirmation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/trades/download_trade_confirmation_api_v1_accounts__account_id__trades__trade_id__confirmation__get","routeSlug":"/products/customer-api/reference/trades/download_trade_confirmation_api_v1_accounts__account_id__trades__trade_id__confirmation__get","metadata":{"seo":{"title":"Download Trade Confirmation","description":"This endpoint downloads the confirmation for a specific trade, and returns a 307 Temporary Redirect to the trade confirmation PDF location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"download_trade_confirmation_api_v1_accounts__account_id__trades__trade_id__confirmation__get","name":"Download Trade Confirmation","isWebhook":false,"pointer":"/paths/~1api~1v1~1accounts~1{account_id}~1trades~1{trade_id}~1confirmation~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download Trade Confirmation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint downloads the confirmation for a specific trade, and returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"307 Temporary Redirect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the trade confirmation PDF location."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trade confirmations are sensitive documents. For security reasons, we return trade confirmations as PDFs through a URL with a 10-minute TTL."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trade confirmation PDFs should be fetched and served just-in-time, not stored in databases."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trades with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"activity\": \"MATURITY\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do not have trade confirmations."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["pockets.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"trade_id","in":"path","schemaId":"schema_261","required":true},{"name":"account_id","in":"path","schemaId":"schema_262","required":true}],"pointer":"/paths/~1api~1v1~1accounts~1{account_id}~1trades~1{trade_id}~1confirmation~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/accounts/{account_id}/trades/{trade_id}/confirmation/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"trade_id","in":"path","required":true,"schemaId":"schema_261"},{"name":"account_id","in":"path","required":true,"schemaId":"schema_262"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["pockets.read"]}],"responseCodes":["307","404","422"],"pointer":"/api/v1/accounts/{account_id}/trades/{trade_id}/confirmation/","href":"trades/download_trade_confirmation_api_v1_accounts__account_id__trades__trade_id__confirmation__get","openApiOperationId":"download_trade_confirmation_api_v1_accounts__account_id__trades__trade_id__confirmation__get","summary":"Download Trade Confirmation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"307","description":"Successful Response"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1accounts~1{account_id}~1trades~1{trade_id}~1confirmation~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"307"},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trades/download_trade_confirmation_api_v1_accounts__account_id__trades__trade_id__confirmation__get"}],"panels":[]}]},"httpPath":"/api/v1/accounts/{account_id}/trades/{trade_id}/confirmation/"},{"label":"List Trades","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/trades/list_trades_api_v2_trades__get","routeSlug":"/products/customer-api/reference/trades/list_trades_api_v2_trades__get","metadata":{"seo":{"title":"List Trades","description":"Returns a list of trades including standard trades (BUY, SELL, MATURITY), external security transfer trades, and same-entity security transfer trades. Optionally filter by pocket."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_trades_api_v2_trades__get","name":"List Trades","isWebhook":false,"pointer":"/paths/~1api~1v2~1trades~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Trades","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of trades including standard trades (BUY, SELL, MATURITY), external security transfer trades, and same-entity security transfer trades. Optionally filter by pocket."},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["pockets.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_236"},{"name":"limit","in":"query","schemaId":"schema_240"},{"name":"pocket_id[]","in":"query","schemaId":"schema_263"},{"name":"trade_datetime_from","in":"query","schemaId":"schema_259"},{"name":"trade_datetime_to","in":"query","schemaId":"schema_260"},{"name":"book_date_from","in":"query","schemaId":"schema_254","description":"Filters the resulting trade list by book date from the provided ISO8601 date, inclusively"},{"name":"book_date_to","in":"query","schemaId":"schema_255","description":"Filters the resulting trade list by book date to the provided ISO8601 date, inclusively"},{"name":"settlement_date_from","in":"query","schemaId":"schema_256","description":"Filters the resulting trade list by settlement date from the provided ISO8601 date, inclusively"},{"name":"settlement_date_to","in":"query","schemaId":"schema_257","description":"Filters the resulting trade list by settlement date to the provided ISO8601 date, inclusively"},{"name":"order","in":"query","schemaId":"schema_241","description":"Ordered by the trade creation time, descending by default."}],"pointer":"/paths/~1api~1v2~1trades~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/trades/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_236"},{"name":"limit","in":"query","required":false,"schemaId":"schema_240"},{"name":"pocket_id[]","in":"query","required":false,"schemaId":"schema_263"},{"name":"trade_datetime_from","in":"query","required":false,"schemaId":"schema_259"},{"name":"trade_datetime_to","in":"query","required":false,"schemaId":"schema_260"},{"name":"book_date_from","in":"query","required":false,"schemaId":"schema_254"},{"name":"book_date_to","in":"query","required":false,"schemaId":"schema_255"},{"name":"settlement_date_from","in":"query","required":false,"schemaId":"schema_256"},{"name":"settlement_date_to","in":"query","required":false,"schemaId":"schema_257"},{"name":"order","in":"query","required":false,"schemaId":"schema_241"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["pockets.read"]}],"responseCodes":["200","404","422"],"pointer":"/api/v2/trades/","href":"trades/list_trades_api_v2_trades__get","openApiOperationId":"list_trades_api_v2_trades__get","summary":"List Trades"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TradeListResponseV2"}},"schemaId":"components/schemas/TradeListResponseV2"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1trades~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TradeListResponseV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TradeListResponseV2"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trades/list_trades_api_v2_trades__get"}],"panels":[]}]},"httpPath":"/api/v2/trades/"}],"content":{"contentType":"group","meta":{"name":"Trades"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trades","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to view Trades, or transactions related to the buying and selling of T-bills, within the brokerage account component of Jiko Pockets."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/trades/","summary":"List Trades","prefix":{"name":"get","color":"get"},"badges":[],"link":"/trades/list_trades_api_v1_trades__get","deprecated":false},{"title":"/api/v1/trades.csv","summary":"Trades As CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/trades/trades_as_csv_api_v1_trades_csv_get","deprecated":false},{"title":"/api/v1/accounts/{account_id}/trades/{trade_id}/confirmation/","summary":"Download Trade Confirmation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/trades/download_trade_confirmation_api_v1_accounts__account_id__trades__trade_id__confirmation__get","deprecated":false},{"title":"/api/v2/trades/","summary":"List Trades","prefix":{"name":"get","color":"get"},"badges":[],"link":"/trades/list_trades_api_v2_trades__get","deprecated":false}]}]}]}]}},{"type":"separator","label":"Transfers","content":null},{"type":"group","label":"Counterparties","link":"/products/customer-api/reference/counterparties","routeSlug":"/products/customer-api/reference/counterparties","items":[{"label":"Get Counterparties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/counterparties/list-counterparties-v2","routeSlug":"/products/customer-api/reference/counterparties/list-counterparties-v2","metadata":{"seo":{"title":"Get Counterparties","description":"This endpoint allows you to list all the counterparties associated with a customer's pocket. You can filter the results bycounterparty type (ach, wire, international_wire, on_us, etc.) and status (PENDING, LINKED, UNLINKED, etc.)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-counterparties-v2","name":"Get Counterparties","isWebhook":false,"pointer":"/paths/~1api~1v2~1counterparties~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Counterparties","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to list all the counterparties associated with a customer's pocket. You can filter the results by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"counterparty type ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wire"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"international_wire"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"on_us"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc.) and status ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LINKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNLINKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc.)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It returns a paginated list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Counterparty"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects. The response includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" token for retrieving more results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Counterparty"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object includes an optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"display_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a custom, human-friendly label that, when set, can be shown in place of the counterparty's default name to distinguish counterparties that belong to the same legal entity."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["customer.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_236"},{"name":"limit","in":"query","schemaId":"schema_237"},{"name":"type","in":"query","schemaId":"schema_264"},{"name":"status","in":"query","schemaId":"schema_265"}],"pointer":"/paths/~1api~1v2~1counterparties~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/counterparties/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_236"},{"name":"limit","in":"query","required":false,"schemaId":"schema_237"},{"name":"type","in":"query","required":false,"schemaId":"schema_264"},{"name":"status","in":"query","required":false,"schemaId":"schema_265"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["customer.read"]}],"responseCodes":["200","422"],"pointer":"/api/v2/counterparties/","href":"counterparties/list-counterparties-v2","openApiOperationId":"list-counterparties-v2","summary":"Get Counterparties"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CounterpartyListResponseV2"}},"schemaId":"components/schemas/CounterpartyListResponseV2"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1counterparties~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CounterpartyListResponseV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CounterpartyListResponseV2"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/counterparties/list-counterparties-v2"}],"panels":[]}]},"httpPath":"/api/v2/counterparties/"},{"label":"Create Counterparty","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/counterparties/create-counterparty-v2","routeSlug":"/products/customer-api/reference/counterparties/create-counterparty-v2","metadata":{"seo":{"title":"Create Counterparty","description":"This endpoint is used to create a new counterparty for a customer. You can create different types of counterparties,including ach, on-us, wire, and international_wire, by providing the relevant details in the request body."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-counterparty-v2","name":"Create Counterparty","isWebhook":false,"pointer":"/paths/~1api~1v2~1counterparties~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Counterparty","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used to create a new counterparty for a customer. You can create different types of counterparties,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"on-us"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wire"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"international_wire"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", by providing the relevant details in the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field for creating an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"on-us"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" counterparty represents the Jiko network address of the pocket."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"display_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field lets you assign a custom, human-friendly name to a counterparty — useful for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"distinguishing multiple counterparties that belong to the same legal entity. When set, it is returned on the counterparty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and can be shown in place of the counterparty's default name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field lets you choose the counterparty's UUID instead of having Jiko generate one. Supplying it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"means you know the counterparty's ID before the call completes, which is useful when the create is subject to an approval"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"workflow — the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"202"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response points at that same ID, so you can correlate the approval with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"counterparty it produces. It also makes a retry safe: re-sending an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that already exists is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CounterpartyAlreadyExistsError"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") rather than creating a duplicate. Omit the field and Jiko assigns the ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body must conform to one of the request schemas. On success, it returns the newly created counterparty object."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["customer.write"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_266","exampleIds":["paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_individual_incoming_wire","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_business_incoming_wire","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_pre_verified","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_supporting_docs","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_unverified","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_biz","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_ind","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_biz","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_ind"]}},"schemaId":"schema_266","exampleIds":["paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_individual_incoming_wire","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_business_incoming_wire","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_pre_verified","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_supporting_docs","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_unverified","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_biz","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_ind","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_biz","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_ind"],"pointer":"/paths/~1api~1v2~1counterparties~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/counterparties/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["customer.write"]}],"requestBody":{"application/json":{"schemaId":"schema_266","exampleIds":["paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_individual_incoming_wire","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_business_incoming_wire","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_pre_verified","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_supporting_docs","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_unverified","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_biz","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_ind","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_biz","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_ind"]}},"responseCodes":["202","422"],"pointer":"/api/v2/counterparties/","href":"counterparties/create-counterparty-v2","openApiOperationId":"create-counterparty-v2","summary":"Create Counterparty"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"schemaId":"schema_266","exampleIds":["paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_individual_incoming_wire","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_business_incoming_wire","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_pre_verified","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_supporting_docs","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_unverified","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_biz","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_ind","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_biz","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_ind"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_266","exampleIds":["paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_individual_incoming_wire","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_business_incoming_wire","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_pre_verified","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_supporting_docs","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_unverified","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_biz","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_ind","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_biz","paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_ind"]}},"examples":[{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}},"schemaId":"schema_267"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1counterparties~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_267","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/counterparties/create-counterparty-v2"}],"panels":[]}]},"httpPath":"/api/v2/counterparties/"},{"label":"Get Counterparty","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/counterparties/get-counterparty-v2","routeSlug":"/products/customer-api/reference/counterparties/get-counterparty-v2","metadata":{"seo":{"title":"Get Counterparty","description":"This endpoint retrieves the details of a specific counterparty by its unique ID. It returns a single counterparty object corresponding to the provided counterparty_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-counterparty-v2","name":"Get Counterparty","isWebhook":false,"pointer":"/paths/~1api~1v2~1counterparties~1{counterparty_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Counterparty","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves the details of a specific counterparty by its unique ID. It returns a single counterparty object corresponding to the provided "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"counterparty_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["customer.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"counterparty_id","in":"path","schemaId":"schema_268","required":true}],"pointer":"/paths/~1api~1v2~1counterparties~1{counterparty_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/counterparties/{counterparty_id}/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"counterparty_id","in":"path","required":true,"schemaId":"schema_268"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["customer.read"]}],"responseCodes":["200","422"],"pointer":"/api/v2/counterparties/{counterparty_id}/","href":"counterparties/get-counterparty-v2","openApiOperationId":"get-counterparty-v2","summary":"Get Counterparty"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_269"}},"schemaId":"schema_269"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1counterparties~1{counterparty_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_269","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_269"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/counterparties/get-counterparty-v2"}],"panels":[]}]},"httpPath":"/api/v2/counterparties/{counterparty_id}/"},{"label":"Update Counterparty","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/counterparties/update-counterparty-v2","routeSlug":"/products/customer-api/reference/counterparties/update-counterparty-v2","metadata":{"seo":{"title":"Update Counterparty","description":"This endpoint is used to update a counterparty. For example, you can use it to unlink a counterparty that is no longer needed, or to set or change its display_name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update-counterparty-v2","name":"Update Counterparty","isWebhook":false,"pointer":"/paths/~1api~1v2~1counterparties~1{counterparty_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Counterparty","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used to update a counterparty. For example, you can use it to unlink a counterparty that is no longer needed, or to set or change its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"display_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body takes an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdateCounterpartyRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object. On success, it returns the updated counterparty object."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["customer.write"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"counterparty_id","in":"path","schemaId":"schema_268","required":true}],"pointer":"/paths/~1api~1v2~1counterparties~1{counterparty_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCounterpartyRequest"}},"schemaId":"components/schemas/UpdateCounterpartyRequest","pointer":"/paths/~1api~1v2~1counterparties~1{counterparty_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v2/counterparties/{counterparty_id}/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"counterparty_id","in":"path","required":true,"schemaId":"schema_268"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["customer.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateCounterpartyRequest"}},"responseCodes":["202","422"],"pointer":"/api/v2/counterparties/{counterparty_id}/","href":"counterparties/update-counterparty-v2","openApiOperationId":"update-counterparty-v2","summary":"Update Counterparty"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"schemaId":"components/schemas/UpdateCounterpartyRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCounterpartyRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}},"schemaId":"schema_267"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1counterparties~1{counterparty_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_267","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/counterparties/update-counterparty-v2"}],"panels":[]}]},"httpPath":"/api/v2/counterparties/{counterparty_id}/"}],"content":{"contentType":"group","meta":{"name":"Counterparties"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Counterparties","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these endpoints to view Counterparties. Counterparties represent external accounts when moving funds in or out of a Jiko Account. Jiko will only transfer funds between accounts where the Counterparty has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status: “VERIFIED”"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", meaning ownership of the account has been confirmed."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/counterparties/","summary":"Get Counterparties","prefix":{"name":"get","color":"get"},"badges":[],"link":"/counterparties/list-counterparties-v2","deprecated":false},{"title":"/api/v2/counterparties/","summary":"Create Counterparty","prefix":{"name":"post","color":"post"},"badges":[],"link":"/counterparties/create-counterparty-v2","deprecated":false},{"title":"/api/v2/counterparties/{counterparty_id}/","summary":"Get Counterparty","prefix":{"name":"get","color":"get"},"badges":[],"link":"/counterparties/get-counterparty-v2","deprecated":false},{"title":"/api/v2/counterparties/{counterparty_id}/","summary":"Update Counterparty","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/counterparties/update-counterparty-v2","deprecated":false}]}]}]}]}},{"type":"group","label":"Transfer Requests","link":"/products/customer-api/reference/transfer-requests","routeSlug":"/products/customer-api/reference/transfer-requests","items":[{"label":"Create Transfer Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/transfer-requests/create_transfer_request_api_v1_transfer_requests__post","routeSlug":"/products/customer-api/reference/transfer-requests/create_transfer_request_api_v1_transfer_requests__post","metadata":{"seo":{"title":"Create Transfer Request","description":"This endpoint creates a new transfer request. This is the first step in a dual-control workflow for making transfers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_transfer_request_api_v1_transfer_requests__post","name":"Create Transfer Request","isWebhook":false,"pointer":"/paths/~1api~1v1~1transfer-requests~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Transfer Request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint creates a new transfer request. This is the first step in a dual-control workflow for making transfers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body requires a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateTransferRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, which specifies the transfer details and the reviewers."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["transfers.write"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTransferRequest","exampleIds":["paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/wire_transfer","paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/on_us_peer_to_peer","paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/on_us_internal_reallocation","paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/usdc_transfer"]}},"schemaId":"components/schemas/CreateTransferRequest","exampleIds":["paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/wire_transfer","paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/on_us_peer_to_peer","paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/on_us_internal_reallocation","paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/usdc_transfer"],"pointer":"/paths/~1api~1v1~1transfer-requests~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/transfer-requests/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["transfers.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateTransferRequest","exampleIds":["paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/wire_transfer","paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/on_us_peer_to_peer","paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/on_us_internal_reallocation","paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/usdc_transfer"]}},"responseCodes":["202","422"],"pointer":"/api/v1/transfer-requests/","href":"transfer-requests/create_transfer_request_api_v1_transfer_requests__post","openApiOperationId":"create_transfer_request_api_v1_transfer_requests__post","summary":"Create Transfer Request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"schemaId":"components/schemas/CreateTransferRequest","exampleIds":["paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/wire_transfer","paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/on_us_peer_to_peer","paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/on_us_internal_reallocation","paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/usdc_transfer"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTransferRequest","exampleIds":["paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/wire_transfer","paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/on_us_peer_to_peer","paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/on_us_internal_reallocation","paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/usdc_transfer"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}},"schemaId":"schema_267"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1transfer-requests~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_267","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer-requests/create_transfer_request_api_v1_transfer_requests__post"}],"panels":[]}]},"httpPath":"/api/v1/transfer-requests/"},{"label":"Get Transfer Requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/transfer-requests/get_transfer_requests_api_v1_transfer_requests__get","routeSlug":"/products/customer-api/reference/transfer-requests/get_transfer_requests_api_v1_transfer_requests__get","metadata":{"seo":{"title":"Get Transfer Requests","description":"This endpoint retrieves a list of transfer requests."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_transfer_requests_api_v1_transfer_requests__get","name":"Get Transfer Requests","isWebhook":false,"pointer":"/paths/~1api~1v1~1transfer-requests~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Transfer Requests","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves a list of transfer requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and other criteria, and returns a paginated list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransferRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["transfers.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status_filter[]","in":"query","schemaId":"schema_270"},{"name":"reviewer_filter[]","in":"query","schemaId":"schema_271"},{"name":"filter[]","in":"query","schemaId":"schema_272","example":["include_unassigned"]},{"name":"exclude_creator_filter[]","in":"query","schemaId":"schema_273"},{"name":"cursor","in":"query","schemaId":"schema_274"},{"name":"limit","in":"query","schemaId":"schema_275"}],"pointer":"/paths/~1api~1v1~1transfer-requests~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/transfer-requests/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"status_filter[]","in":"query","required":false,"schemaId":"schema_270"},{"name":"reviewer_filter[]","in":"query","required":false,"schemaId":"schema_271"},{"name":"filter[]","in":"query","required":false,"example":["include_unassigned"],"schemaId":"schema_272"},{"name":"exclude_creator_filter[]","in":"query","required":false,"schemaId":"schema_273"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_274"},{"name":"limit","in":"query","required":false,"schemaId":"schema_275"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["transfers.read"]}],"responseCodes":["200","422"],"pointer":"/api/v1/transfer-requests/","href":"transfer-requests/get_transfer_requests_api_v1_transfer_requests__get","openApiOperationId":"get_transfer_requests_api_v1_transfer_requests__get","summary":"Get Transfer Requests"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferRequestsResponse"}},"schemaId":"components/schemas/TransferRequestsResponse"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1transfer-requests~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransferRequestsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferRequestsResponse"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer-requests/get_transfer_requests_api_v1_transfer_requests__get"}],"panels":[]}]},"httpPath":"/api/v1/transfer-requests/"},{"label":"Get Transfer Request Reviewers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/transfer-requests/get_transfer_request_reviewers_api_v1_transfer_requests_reviewers__get","routeSlug":"/products/customer-api/reference/transfer-requests/get_transfer_request_reviewers_api_v1_transfer_requests_reviewers__get","metadata":{"seo":{"title":"Get Transfer Request Reviewers","description":"This endpoint retrieves a list of team members who are authorized to review transfer requests, and returns a list of DualAuthUser objects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_transfer_request_reviewers_api_v1_transfer_requests_reviewers__get","name":"Get Transfer Request Reviewers","isWebhook":false,"pointer":"/paths/~1api~1v1~1transfer-requests~1reviewers~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Transfer Request Reviewers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves a list of team members who are authorized to review transfer requests, and returns a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DualAuthUser"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["transfers.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/transfer-requests/reviewers/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["transfers.read"]}],"responseCodes":["200"],"pointer":"/api/v1/transfer-requests/reviewers/","href":"transfer-requests/get_transfer_request_reviewers_api_v1_transfer_requests_reviewers__get","openApiOperationId":"get_transfer_request_reviewers_api_v1_transfer_requests_reviewers__get","summary":"Get Transfer Request Reviewers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_276"}},"schemaId":"schema_276"}],"pointer":"/paths/~1api~1v1~1transfer-requests~1reviewers~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_276","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_276"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer-requests/get_transfer_request_reviewers_api_v1_transfer_requests_reviewers__get"}],"panels":[]}]},"httpPath":"/api/v1/transfer-requests/reviewers/"},{"label":"Get Transfer Request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/transfer-requests/get_transfer_request_api_v1_transfer_requests__transfer_id___get","routeSlug":"/products/customer-api/reference/transfer-requests/get_transfer_request_api_v1_transfer_requests__transfer_id___get","metadata":{"seo":{"title":"Get Transfer Request","description":"This endpoint retrieves the details of a specific transfer request, and returns a single TransferRequest object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_transfer_request_api_v1_transfer_requests__transfer_id___get","name":"Get Transfer Request","isWebhook":false,"pointer":"/paths/~1api~1v1~1transfer-requests~1{transfer_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Transfer Request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves the details of a specific transfer request, and returns a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransferRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["transfers.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transfer_id","in":"path","schemaId":"schema_277","required":true}],"pointer":"/paths/~1api~1v1~1transfer-requests~1{transfer_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/transfer-requests/{transfer_id}/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"transfer_id","in":"path","required":true,"schemaId":"schema_277"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["transfers.read"]}],"responseCodes":["200","422"],"pointer":"/api/v1/transfer-requests/{transfer_id}/","href":"transfer-requests/get_transfer_request_api_v1_transfer_requests__transfer_id___get","openApiOperationId":"get_transfer_request_api_v1_transfer_requests__transfer_id___get","summary":"Get Transfer Request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferRequest"}},"schemaId":"components/schemas/TransferRequest"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1transfer-requests~1{transfer_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransferRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferRequest"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer-requests/get_transfer_request_api_v1_transfer_requests__transfer_id___get"}],"panels":[]}]},"httpPath":"/api/v1/transfer-requests/{transfer_id}/"},{"label":"Cancel Transfer Request","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/transfer-requests/cancel_transfer_request_api_v1_transfer_requests__transfer_id___delete","routeSlug":"/products/customer-api/reference/transfer-requests/cancel_transfer_request_api_v1_transfer_requests__transfer_id___delete","metadata":{"seo":{"title":"Cancel Transfer Request","description":"This endpoint cancels a pending transfer request, and returns a 204 No Content response upon a successful cancellation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancel_transfer_request_api_v1_transfer_requests__transfer_id___delete","name":"Cancel Transfer Request","isWebhook":false,"pointer":"/paths/~1api~1v1~1transfer-requests~1{transfer_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel Transfer Request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint cancels a pending transfer request, and returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204 No Content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response upon a successful cancellation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["transfers.write"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transfer_id","in":"path","schemaId":"schema_277","required":true}],"pointer":"/paths/~1api~1v1~1transfer-requests~1{transfer_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/transfer-requests/{transfer_id}/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"transfer_id","in":"path","required":true,"schemaId":"schema_277"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["transfers.write"]}],"responseCodes":["204","422"],"pointer":"/api/v1/transfer-requests/{transfer_id}/","href":"transfer-requests/cancel_transfer_request_api_v1_transfer_requests__transfer_id___delete","openApiOperationId":"cancel_transfer_request_api_v1_transfer_requests__transfer_id___delete","summary":"Cancel Transfer Request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful Response"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1transfer-requests~1{transfer_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer-requests/cancel_transfer_request_api_v1_transfer_requests__transfer_id___delete"}],"panels":[]}]},"httpPath":"/api/v1/transfer-requests/{transfer_id}/"},{"label":"Update Transfer Request Status","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/transfer-requests/update_transfer_request_status_api_v1_transfer_requests__transfer_id__status__patch","routeSlug":"/products/customer-api/reference/transfer-requests/update_transfer_request_status_api_v1_transfer_requests__transfer_id__status__patch","metadata":{"seo":{"title":"Update Transfer Request Status","description":"This endpoint is used to approve or deny a transfer request as part of a dual-control workflow."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_transfer_request_status_api_v1_transfer_requests__transfer_id__status__patch","name":"Update Transfer Request Status","isWebhook":false,"pointer":"/paths/~1api~1v1~1transfer-requests~1{transfer_id}~1status~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Transfer Request Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used to approve or deny a transfer request as part of a dual-control workflow."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body requires an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdateTransferRequestStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object. It returns the updated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransferRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["transfers.write"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transfer_id","in":"path","schemaId":"schema_277","required":true}],"pointer":"/paths/~1api~1v1~1transfer-requests~1{transfer_id}~1status~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTransferRequestStatus"}},"schemaId":"components/schemas/UpdateTransferRequestStatus","pointer":"/paths/~1api~1v1~1transfer-requests~1{transfer_id}~1status~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/transfer-requests/{transfer_id}/status/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"transfer_id","in":"path","required":true,"schemaId":"schema_277"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["transfers.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateTransferRequestStatus"}},"responseCodes":["200","422"],"pointer":"/api/v1/transfer-requests/{transfer_id}/status/","href":"transfer-requests/update_transfer_request_status_api_v1_transfer_requests__transfer_id__status__patch","openApiOperationId":"update_transfer_request_status_api_v1_transfer_requests__transfer_id__status__patch","summary":"Update Transfer Request Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"schemaId":"components/schemas/UpdateTransferRequestStatus","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTransferRequestStatus"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferRequest"}},"schemaId":"components/schemas/TransferRequest"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1transfer-requests~1{transfer_id}~1status~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransferRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferRequest"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer-requests/update_transfer_request_status_api_v1_transfer_requests__transfer_id__status__patch"}],"panels":[]}]},"httpPath":"/api/v1/transfer-requests/{transfer_id}/status/"}],"content":{"contentType":"group","meta":{"name":"Transfer Requests"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfer Requests","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to manage Dual Authorization for Tranfer Requests."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/transfer-requests/","summary":"Create Transfer Request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transfer-requests/create_transfer_request_api_v1_transfer_requests__post","deprecated":false},{"title":"/api/v1/transfer-requests/","summary":"Get Transfer Requests","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfer-requests/get_transfer_requests_api_v1_transfer_requests__get","deprecated":false},{"title":"/api/v1/transfer-requests/reviewers/","summary":"Get Transfer Request Reviewers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfer-requests/get_transfer_request_reviewers_api_v1_transfer_requests_reviewers__get","deprecated":false},{"title":"/api/v1/transfer-requests/{transfer_id}/","summary":"Get Transfer Request","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfer-requests/get_transfer_request_api_v1_transfer_requests__transfer_id___get","deprecated":false},{"title":"/api/v1/transfer-requests/{transfer_id}/","summary":"Cancel Transfer Request","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/transfer-requests/cancel_transfer_request_api_v1_transfer_requests__transfer_id___delete","deprecated":false},{"title":"/api/v1/transfer-requests/{transfer_id}/status/","summary":"Update Transfer Request Status","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/transfer-requests/update_transfer_request_status_api_v1_transfer_requests__transfer_id__status__patch","deprecated":false}]}]}]}]}},{"type":"group","label":"Wires","link":"/products/customer-api/reference/wires","routeSlug":"/products/customer-api/reference/wires","items":[{"label":"List Wires","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/wires/list-wires-v1","routeSlug":"/products/customer-api/reference/wires/list-wires-v1","metadata":{"seo":{"title":"List Wires","description":"List Wires"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-wires-v1","name":"List Wires","isWebhook":false,"pointer":"/paths/~1api~1v1~1wires~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Wires","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["transfers.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_236"},{"name":"limit","in":"query","schemaId":"schema_278"},{"name":"direction","in":"query","schemaId":"schema_279"}],"pointer":"/paths/~1api~1v1~1wires~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/wires/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_236"},{"name":"limit","in":"query","required":false,"schemaId":"schema_278"},{"name":"direction","in":"query","required":false,"schemaId":"schema_279"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["transfers.read"]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/wires/","href":"wires/list-wires-v1","openApiOperationId":"list-wires-v1","summary":"List Wires"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WireListResponse"}},"schemaId":"components/schemas/WireListResponse"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1wires~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WireListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WireListResponse"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/wires/list-wires-v1"}],"panels":[]}]},"httpPath":"/api/v1/wires/"},{"label":"Get Wire","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/wires/get-wire-v1","routeSlug":"/products/customer-api/reference/wires/get-wire-v1","metadata":{"seo":{"title":"Get Wire","description":"Get Wire"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-wire-v1","name":"Get Wire","isWebhook":false,"pointer":"/paths/~1api~1v1~1wires~1{wire_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Wire","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["transfers.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"wire_id","in":"path","schemaId":"schema_280","required":true}],"pointer":"/paths/~1api~1v1~1wires~1{wire_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/wires/{wire_id}/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"wire_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["transfers.read"]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/wires/{wire_id}/","href":"wires/get-wire-v1","openApiOperationId":"get-wire-v1","summary":"Get Wire"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_281"}},"schemaId":"schema_281"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1wires~1{wire_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_281","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_281"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/wires/get-wire-v1"}],"panels":[]}]},"httpPath":"/api/v1/wires/{wire_id}/"}],"content":{"contentType":"group","meta":{"name":"Wires"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Wires","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/wires/","summary":"List Wires","prefix":{"name":"get","color":"get"},"badges":[],"link":"/wires/list-wires-v1","deprecated":false},{"title":"/api/v1/wires/{wire_id}/","summary":"Get Wire","prefix":{"name":"get","color":"get"},"badges":[],"link":"/wires/get-wire-v1","deprecated":false}]}]}]}]}},{"type":"separator","label":"Webhooks & Event Notifications","content":null},{"type":"group","label":"Subscriptions","link":"/products/customer-api/reference/subscriptions","routeSlug":"/products/customer-api/reference/subscriptions","items":[{"label":"Create Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/subscriptions/create_subscription_api_v1_subscriptions__post","routeSlug":"/products/customer-api/reference/subscriptions/create_subscription_api_v1_subscriptions__post","metadata":{"seo":{"title":"Create Subscription","description":"This endpoint creates a new webhook subscription to receive real-time notifications for specified events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_subscription_api_v1_subscriptions__post","name":"Create Subscription","isWebhook":false,"pointer":"/paths/~1api~1v1~1subscriptions~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint creates a new webhook subscription to receive real-time notifications for specified events."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body requires a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateSubscriptionRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, which includes the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the webhook, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to subscribe to, and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shared_secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for verifying request signatures."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["subscriptions.write"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSubscriptionRequest"}},"schemaId":"components/schemas/CreateSubscriptionRequest","pointer":"/paths/~1api~1v1~1subscriptions~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/subscriptions/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["subscriptions.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateSubscriptionRequest"}},"responseCodes":["201","422"],"pointer":"/api/v1/subscriptions/","href":"subscriptions/create_subscription_api_v1_subscriptions__post","openApiOperationId":"create_subscription_api_v1_subscriptions__post","summary":"Create Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"schemaId":"components/schemas/CreateSubscriptionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSubscriptionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}},"schemaId":"schema_267"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1subscriptions~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_267","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/create_subscription_api_v1_subscriptions__post"}],"panels":[]}]},"httpPath":"/api/v1/subscriptions/"},{"label":"Get Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/subscriptions/get_subscriptions_api_v1_subscriptions__get","routeSlug":"/products/customer-api/reference/subscriptions/get_subscriptions_api_v1_subscriptions__get","metadata":{"seo":{"title":"Get Subscriptions","description":"This endpoint lists all of your current webhook subscriptions, and returns a paginated list of Subscription objects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_subscriptions_api_v1_subscriptions__get","name":"Get Subscriptions","isWebhook":false,"pointer":"/paths/~1api~1v1~1subscriptions~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Subscriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists all of your current webhook subscriptions, and returns a paginated list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["subscriptions.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_236"},{"name":"limit","in":"query","schemaId":"schema_282"}],"pointer":"/paths/~1api~1v1~1subscriptions~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/subscriptions/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_236"},{"name":"limit","in":"query","required":false,"schemaId":"schema_282"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["subscriptions.read"]}],"responseCodes":["200","422"],"pointer":"/api/v1/subscriptions/","href":"subscriptions/get_subscriptions_api_v1_subscriptions__get","openApiOperationId":"get_subscriptions_api_v1_subscriptions__get","summary":"Get Subscriptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorListResponse_Subscription_"}},"schemaId":"components/schemas/CursorListResponse_Subscription_"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1subscriptions~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorListResponse_Subscription_","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorListResponse_Subscription_"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/get_subscriptions_api_v1_subscriptions__get"}],"panels":[]}]},"httpPath":"/api/v1/subscriptions/"},{"label":"Update Subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/subscriptions/update_subscription_api_v1_subscriptions__subscription_id___patch","routeSlug":"/products/customer-api/reference/subscriptions/update_subscription_api_v1_subscriptions__subscription_id___patch","metadata":{"seo":{"title":"Update Subscription","description":"This endpoint updates an existing webhook subscription. You can change the url, the subscribed events, or the status (enabled/disabled)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_subscription_api_v1_subscriptions__subscription_id___patch","name":"Update Subscription","isWebhook":false,"pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint updates an existing webhook subscription. You can change the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the subscribed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body requires an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdateSubscriptionRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object. It returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"202 Accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response with the updated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["subscriptions.write"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_283","required":true}],"pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSubscriptionRequest"}},"schemaId":"components/schemas/UpdateSubscriptionRequest","pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/subscriptions/{subscription_id}/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_283"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["subscriptions.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateSubscriptionRequest"}},"responseCodes":["202","422"],"pointer":"/api/v1/subscriptions/{subscription_id}/","href":"subscriptions/update_subscription_api_v1_subscriptions__subscription_id___patch","openApiOperationId":"update_subscription_api_v1_subscriptions__subscription_id___patch","summary":"Update Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"schemaId":"components/schemas/UpdateSubscriptionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSubscriptionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription"}},"schemaId":"components/schemas/Subscription"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/Subscription","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/update_subscription_api_v1_subscriptions__subscription_id___patch"}],"panels":[]}]},"httpPath":"/api/v1/subscriptions/{subscription_id}/"},{"label":"Get Subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/subscriptions/get_subscription_api_v1_subscriptions__subscription_id___get","routeSlug":"/products/customer-api/reference/subscriptions/get_subscription_api_v1_subscriptions__subscription_id___get","metadata":{"seo":{"title":"Get Subscription","description":"This endpoint retrieves the details of a specific webhook subscription, and returns a single Subscription object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_subscription_api_v1_subscriptions__subscription_id___get","name":"Get Subscription","isWebhook":false,"pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves the details of a specific webhook subscription, and returns a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["subscriptions.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_283","required":true}],"pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/subscriptions/{subscription_id}/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_283"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["subscriptions.read"]}],"responseCodes":["200","422"],"pointer":"/api/v1/subscriptions/{subscription_id}/","href":"subscriptions/get_subscription_api_v1_subscriptions__subscription_id___get","openApiOperationId":"get_subscription_api_v1_subscriptions__subscription_id___get","summary":"Get Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription"}},"schemaId":"components/schemas/Subscription"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Subscription","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/get_subscription_api_v1_subscriptions__subscription_id___get"}],"panels":[]}]},"httpPath":"/api/v1/subscriptions/{subscription_id}/"},{"label":"Delete Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/subscriptions/delete_subscription_api_v1_subscriptions__subscription_id___delete","routeSlug":"/products/customer-api/reference/subscriptions/delete_subscription_api_v1_subscriptions__subscription_id___delete","metadata":{"seo":{"title":"Delete Subscription","description":"This endpoint deletes a webhook subscription, and returns a 202 Accepted response upon successful deletion."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_subscription_api_v1_subscriptions__subscription_id___delete","name":"Delete Subscription","isWebhook":false,"pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint deletes a webhook subscription, and returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"202 Accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response upon successful deletion."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["subscriptions.write"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_283","required":true}],"pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/subscriptions/{subscription_id}/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_283"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["subscriptions.write"]}],"responseCodes":["202","422"],"pointer":"/api/v1/subscriptions/{subscription_id}/","href":"subscriptions/delete_subscription_api_v1_subscriptions__subscription_id___delete","openApiOperationId":"delete_subscription_api_v1_subscriptions__subscription_id___delete","summary":"Delete Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}},"schemaId":"schema_267"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_267","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/delete_subscription_api_v1_subscriptions__subscription_id___delete"}],"panels":[]}]},"httpPath":"/api/v1/subscriptions/{subscription_id}/"}],"content":{"contentType":"group","meta":{"name":"Subscriptions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscriptions","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to create, view, and manage Subscriptions. Subscriptions provide Partners with the ability to subscribe to Events. Once subscribed, Events will be sent to the specified URL."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/subscriptions/","summary":"Create Subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/create_subscription_api_v1_subscriptions__post","deprecated":false},{"title":"/api/v1/subscriptions/","summary":"Get Subscriptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/get_subscriptions_api_v1_subscriptions__get","deprecated":false},{"title":"/api/v1/subscriptions/{subscription_id}/","summary":"Update Subscription","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/subscriptions/update_subscription_api_v1_subscriptions__subscription_id___patch","deprecated":false},{"title":"/api/v1/subscriptions/{subscription_id}/","summary":"Get Subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/get_subscription_api_v1_subscriptions__subscription_id___get","deprecated":false},{"title":"/api/v1/subscriptions/{subscription_id}/","summary":"Delete Subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subscriptions/delete_subscription_api_v1_subscriptions__subscription_id___delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Events","link":"/products/customer-api/reference/events","routeSlug":"/products/customer-api/reference/events","items":[{"label":"Get Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/events/get_events_api_v1_events__get","routeSlug":"/products/customer-api/reference/events/get_events_api_v1_events__get","metadata":{"seo":{"title":"Get Events","description":"This endpoint retrieves a list of events that have occurred for a customer's account, often related to webhook notifications. You can filter events by subscription_id and/or a time range query parameter (after)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_events_api_v1_events__get","name":"Get Events","isWebhook":false,"pointer":"/paths/~1api~1v1~1events~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves a list of events that have occurred for a customer's account, often related to webhook notifications. You can filter events by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or a time range query parameter ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It returns a paginated list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects, each containing details about the event and any delivery attempts if it's a webhook event."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["subscriptions.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subscription_id","in":"query","schemaId":"schema_284"},{"name":"cursor","in":"query","schemaId":"schema_236"},{"name":"limit","in":"query","schemaId":"schema_282"},{"name":"after","in":"query","schemaId":"schema_285"}],"pointer":"/paths/~1api~1v1~1events~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/events/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"subscription_id","in":"query","required":false,"schemaId":"schema_284"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_236"},{"name":"limit","in":"query","required":false,"schemaId":"schema_282"},{"name":"after","in":"query","required":false,"schemaId":"schema_285"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["subscriptions.read"]}],"responseCodes":["200","422"],"pointer":"/api/v1/events/","href":"events/get_events_api_v1_events__get","openApiOperationId":"get_events_api_v1_events__get","summary":"Get Events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorListResponse_Event_"}},"schemaId":"components/schemas/CursorListResponse_Event_"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1events~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorListResponse_Event_","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorListResponse_Event_"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/get_events_api_v1_events__get"}],"panels":[]}]},"httpPath":"/api/v1/events/"}],"content":{"contentType":"group","meta":{"name":"Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Events","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to view Events."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/events/","summary":"Get Events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/get_events_api_v1_events__get","deprecated":false}]}]}]}]}},{"type":"group","label":"Notifications","link":"/products/customer-api/reference/notifications","routeSlug":"/products/customer-api/reference/notifications","items":[{"label":"List Notifications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/notifications/list_notifications_api_v1_notifications__get","routeSlug":"/products/customer-api/reference/notifications/list_notifications_api_v1_notifications__get","metadata":{"seo":{"title":"List Notifications","description":"This endpoint lists all notifications for a customer. You can filter by status (READ or UNREAD)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_notifications_api_v1_notifications__get","name":"List Notifications","isWebhook":false,"pointer":"/paths/~1api~1v1~1notifications~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Notifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists all notifications for a customer. You can filter by status ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNREAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It returns a paginated list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerNotification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["notifications.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_286"},{"name":"cursor","in":"query","schemaId":"schema_236"},{"name":"limit","in":"query","schemaId":"schema_282"}],"pointer":"/paths/~1api~1v1~1notifications~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/notifications/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"status","in":"query","required":false,"schemaId":"schema_286"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_236"},{"name":"limit","in":"query","required":false,"schemaId":"schema_282"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["notifications.read"]}],"responseCodes":["200","422"],"pointer":"/api/v1/notifications/","href":"notifications/list_notifications_api_v1_notifications__get","openApiOperationId":"list_notifications_api_v1_notifications__get","summary":"List Notifications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerNotificationsResult"}},"schemaId":"components/schemas/CustomerNotificationsResult"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1notifications~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerNotificationsResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerNotificationsResult"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/list_notifications_api_v1_notifications__get"}],"panels":[]}]},"httpPath":"/api/v1/notifications/"},{"label":"Get Notification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/notifications/get_notification_api_v1_notifications__notification_id___get","routeSlug":"/products/customer-api/reference/notifications/get_notification_api_v1_notifications__notification_id___get","metadata":{"seo":{"title":"Get Notification","description":"This endpoint retrieves a single notification by its notification_id, and returns a CustomerNotification object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_notification_api_v1_notifications__notification_id___get","name":"Get Notification","isWebhook":false,"pointer":"/paths/~1api~1v1~1notifications~1{notification_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Notification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves a single notification by its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notification_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerNotification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["notifications.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"notification_id","in":"path","schemaId":"schema_287","required":true}],"pointer":"/paths/~1api~1v1~1notifications~1{notification_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/notifications/{notification_id}/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"notification_id","in":"path","required":true,"schemaId":"schema_287"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["notifications.read"]}],"responseCodes":["200","422"],"pointer":"/api/v1/notifications/{notification_id}/","href":"notifications/get_notification_api_v1_notifications__notification_id___get","openApiOperationId":"get_notification_api_v1_notifications__notification_id___get","summary":"Get Notification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerNotification"}},"schemaId":"components/schemas/CustomerNotification"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1notifications~1{notification_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerNotification","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerNotification"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/get_notification_api_v1_notifications__notification_id___get"}],"panels":[]}]},"httpPath":"/api/v1/notifications/{notification_id}/"},{"label":"Patch Notification","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/notifications/patch_notification_api_v1_notifications__notification_id___patch","routeSlug":"/products/customer-api/reference/notifications/patch_notification_api_v1_notifications__notification_id___patch","metadata":{"seo":{"title":"Patch Notification","description":"This endpoint allows you to update the status of a notification, for example, to mark it as read."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patch_notification_api_v1_notifications__notification_id___patch","name":"Patch Notification","isWebhook":false,"pointer":"/paths/~1api~1v1~1notifications~1{notification_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch Notification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to update the status of a notification, for example, to mark it as read."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body must contain an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UpdateCustomerNotificationStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object. It returns the updated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerNotification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["notifications.write"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"notification_id","in":"path","schemaId":"schema_287","required":true}],"pointer":"/paths/~1api~1v1~1notifications~1{notification_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCustomerNotificationStatus"}},"schemaId":"components/schemas/UpdateCustomerNotificationStatus","pointer":"/paths/~1api~1v1~1notifications~1{notification_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/notifications/{notification_id}/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"notification_id","in":"path","required":true,"schemaId":"schema_287"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["notifications.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateCustomerNotificationStatus"}},"responseCodes":["200","422"],"pointer":"/api/v1/notifications/{notification_id}/","href":"notifications/patch_notification_api_v1_notifications__notification_id___patch","openApiOperationId":"patch_notification_api_v1_notifications__notification_id___patch","summary":"Patch Notification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"schemaId":"components/schemas/UpdateCustomerNotificationStatus","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCustomerNotificationStatus"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerNotification"}},"schemaId":"components/schemas/CustomerNotification"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1notifications~1{notification_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerNotification","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerNotification"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/patch_notification_api_v1_notifications__notification_id___patch"}],"panels":[]}]},"httpPath":"/api/v1/notifications/{notification_id}/"}],"content":{"contentType":"group","meta":{"name":"Notifications"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notifications","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints for interacting with Notifications."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/notifications/","summary":"List Notifications","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notifications/list_notifications_api_v1_notifications__get","deprecated":false},{"title":"/api/v1/notifications/{notification_id}/","summary":"Get Notification","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notifications/get_notification_api_v1_notifications__notification_id___get","deprecated":false},{"title":"/api/v1/notifications/{notification_id}/","summary":"Patch Notification","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/notifications/patch_notification_api_v1_notifications__notification_id___patch","deprecated":false}]}]}]}]}},{"type":"separator","label":"Statements & Reports","content":null},{"type":"group","label":"Statements","link":"/products/customer-api/reference/statements","routeSlug":"/products/customer-api/reference/statements","items":[{"label":"List Customer Statements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/statements/list_customer_statements_api_v1_statements__get","routeSlug":"/products/customer-api/reference/statements/list_customer_statements_api_v1_statements__get","metadata":{"seo":{"title":"List Customer Statements","description":"This endpoint retrieves a list of all available account statements (e.g., BANK, BROKERAGE) and tax documents (1099-INT, 1099-B)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_customer_statements_api_v1_statements__get","name":"List Customer Statements","isWebhook":false,"pointer":"/paths/~1api~1v1~1statements~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Customer Statements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves a list of all available account statements (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BROKERAGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and tax documents ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1099-INT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1099-B"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StatementListResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The list can be filtered by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", statement "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and date "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., \"2023\" or \"2023-01\")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customers can expect monthly statements to be available by the 15th of every month."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["pockets.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type[]","in":"query","schemaId":"schema_288"},{"name":"cursor","in":"query","schemaId":"schema_236"},{"name":"limit","in":"query","schemaId":"schema_289"},{"name":"order","in":"query","schemaId":"schema_241"},{"name":"account[]","in":"query","schemaId":"schema_258"},{"name":"key","in":"query","schemaId":"schema_290"}],"pointer":"/paths/~1api~1v1~1statements~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/statements/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"type[]","in":"query","required":false,"schemaId":"schema_288"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_236"},{"name":"limit","in":"query","required":false,"schemaId":"schema_289"},{"name":"order","in":"query","required":false,"schemaId":"schema_241"},{"name":"account[]","in":"query","required":false,"schemaId":"schema_258"},{"name":"key","in":"query","required":false,"schemaId":"schema_290"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["pockets.read"]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/statements/","href":"statements/list_customer_statements_api_v1_statements__get","openApiOperationId":"list_customer_statements_api_v1_statements__get","summary":"List Customer Statements"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementListResponse"}},"schemaId":"components/schemas/StatementListResponse"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1statements~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatementListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementListResponse"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statements/list_customer_statements_api_v1_statements__get"}],"panels":[]}]},"httpPath":"/api/v1/statements/"}],"content":{"contentType":"group","meta":{"name":"Statements"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Statements","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to retrieve monthly statements for bank and brokerage accounts."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/statements/","summary":"List Customer Statements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statements/list_customer_statements_api_v1_statements__get","deprecated":false}]}]}]}]}},{"type":"group","label":"Reports","link":"/products/customer-api/reference/reports","routeSlug":"/products/customer-api/reference/reports","items":[{"label":"Create Customer Report Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/reports/create_customer_report_request_api_v1_report_requests__post","routeSlug":"/products/customer-api/reference/reports/create_customer_report_request_api_v1_report_requests__post","metadata":{"seo":{"title":"Create Customer Report Request","description":"This endpoint triggers an asynchronous process to create a report request based on the provided parameters. Available report types are:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_customer_report_request_api_v1_report_requests__post","name":"Create Customer Report Request","isWebhook":false,"pointer":"/paths/~1api~1v1~1report-requests~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Customer Report Request","badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint triggers an asynchronous process to create a report request based on the provided parameters. Available report types are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"reports/create_customer_report_request_api_v1_report_requests__post/request/type-bank_statement_report","deepLinkHash":"/reports/create_customer_report_request_api_v1_report_requests__post#reports/create_customer_report_request_api_v1_report_requests__post/request/type-bank_statement_report"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_STATEMENT_REPORT"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End-of-day bank statement for the pocket’s bank account, exported in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 20022 camt.053 format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Transactions reported in this statement include fund deposits and withdrawals, incoming and outgoing third-party payments (when applicable), fees, automated sweep transactions between the pocket’s bank account and its linked brokerage account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" since Jiko automatically sweeps funds between the bank account and the associated brokerage account in the pocket, the bank account’s end-of-day balance is always 0. To report on balances held with Jiko, we invite you to use:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either the Brokerage statement, to import the value of held T-bills in the cash position of your treasury management system, reported as the closing balance of an account,"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or the Trade report, to import individual buy and sell transactions into your treasury management system and derive the corresponding position."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"output_formats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CAMT053"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"reports/create_customer_report_request_api_v1_report_requests__post/request/type-brokerage_statement_report","deepLinkHash":"/reports/create_customer_report_request_api_v1_report_requests__post#reports/create_customer_report_request_api_v1_report_requests__post/request/type-brokerage_statement_report"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BROKERAGE_STATEMENT_REPORT"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End-of-day statement for the pocket’s brokerage account, exported in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 20022 camt.053 format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". With the opening value and closing value of the T-bills held in the pocket on the selected reporting date, represented as the account balance. Values are based on end-of-day market prices, or on the current market price if the report is generated before day-end."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The statement also includes the following records that explain the change between the opening and closing values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additions: new funds deposited into the brokerage account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subtractions: funds withdrawn from the brokerage account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gains/Losses from T-bills held in the account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fees charged and deducted from the brokerage account."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"output_formats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CAMT053"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"reports/create_customer_report_request_api_v1_report_requests__post/request/type-trade_report","deepLinkHash":"/reports/create_customer_report_request_api_v1_report_requests__post#reports/create_customer_report_request_api_v1_report_requests__post/request/type-trade_report"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRADE_REPORT"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of T-bill buy & sell trades within a user-defined range of trade dates, exported in CSV format. Each trade in the file includes three categories of information:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security master data: CUSIP, issuer, issue date, maturity date."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trading entity parameters: transaction code, custodian details."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trade details: buy/sell indicator, trade date, price, amount, reference."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date ranges filter has a maximum range of 31 days. Optionally, the date range filter can be configured to be based on either settlement dates, or book dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"output_formats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KYRIBA_CSV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CSV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"reports/create_customer_report_request_api_v1_report_requests__post/request/type-security_price_report","deepLinkHash":"/reports/create_customer_report_request_api_v1_report_requests__post#reports/create_customer_report_request_api_v1_report_requests__post/request/type-security_price_report"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SECURITY_PRICE_REPORT"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End-of-day security prices within a user-defined range of dates, exported in CSV format. With:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An “SE” field identifying the entry as a security price."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the price provider: “JIKO”."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The CUSIP of the security."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The pricing date."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end-of-day price."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"output_formats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KYRIBA_CSV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"reports/create_customer_report_request_api_v1_report_requests__post/request/type-position_summary_report","deepLinkHash":"/reports/create_customer_report_request_api_v1_report_requests__post#reports/create_customer_report_request_api_v1_report_requests__post/request/type-position_summary_report"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POSITION_SUMMARY_REPORT"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides a snapshot of holdings as of a user-selected date, showing CUSIP-level positions by pocket along with associated cash values. The report includes the following key fields: Pocket, CUSIP, Quantity, Market Price, Market Value, and Historical Cost Value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customers use this report to export pocket-level valuations to downstream systems and to reconcile imported buy and sell transactions against the quantities reflected in the Position Summary"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"output_formats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PDF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CSV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["reports.write"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateReportRequest","exampleIds":["paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/bank_statement","paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/trade_report","paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/security_price","paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/brokerage_statement","paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/position_summary"]}},"schemaId":"components/schemas/CreateReportRequest","exampleIds":["paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/bank_statement","paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/trade_report","paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/security_price","paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/brokerage_statement","paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/position_summary"],"pointer":"/paths/~1api~1v1~1report-requests~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/report-requests/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["reports.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateReportRequest","exampleIds":["paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/bank_statement","paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/trade_report","paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/security_price","paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/brokerage_statement","paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/position_summary"]}},"responseCodes":["201","404","422"],"pointer":"/api/v1/report-requests/","href":"reports/create_customer_report_request_api_v1_report_requests__post","openApiOperationId":"create_customer_report_request_api_v1_report_requests__post","summary":"Create Customer Report Request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"schemaId":"components/schemas/CreateReportRequest","exampleIds":["paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/bank_statement","paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/trade_report","paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/security_price","paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/brokerage_statement","paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/position_summary"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateReportRequest","exampleIds":["paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/bank_statement","paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/trade_report","paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/security_price","paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/brokerage_statement","paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/position_summary"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1report-requests~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/create_customer_report_request_api_v1_report_requests__post"}],"panels":[]}]},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v1/report-requests/"},{"label":"List Customer Report Requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/reports/list_customer_report_requests_api_v1_report_requests__get","routeSlug":"/products/customer-api/reference/reports/list_customer_report_requests_api_v1_report_requests__get","metadata":{"seo":{"title":"List Customer Report Requests","description":"This endpoint lists all report request for a customer. You can filter by date from and to"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_customer_report_requests_api_v1_report_requests__get","name":"List Customer Report Requests","isWebhook":false,"pointer":"/paths/~1api~1v1~1report-requests~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Customer Report Requests","badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists all report request for a customer. You can filter by date from and to"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It returns a paginated list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ReportRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["reports.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_236"},{"name":"limit","in":"query","schemaId":"schema_240"},{"name":"date_from","in":"query","schemaId":"schema_291"},{"name":"date_to","in":"query","schemaId":"schema_292"}],"pointer":"/paths/~1api~1v1~1report-requests~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/report-requests/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_236"},{"name":"limit","in":"query","required":false,"schemaId":"schema_240"},{"name":"date_from","in":"query","required":false,"schemaId":"schema_291"},{"name":"date_to","in":"query","required":false,"schemaId":"schema_292"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["reports.read"]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/report-requests/","href":"reports/list_customer_report_requests_api_v1_report_requests__get","openApiOperationId":"list_customer_report_requests_api_v1_report_requests__get","summary":"List Customer Report Requests"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportRequestListResponse"}},"schemaId":"components/schemas/ReportRequestListResponse"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1report-requests~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportRequestListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportRequestListResponse"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/list_customer_report_requests_api_v1_report_requests__get"}],"panels":[]}]},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v1/report-requests/"},{"label":"Get Customer Report Request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/reports/get_customer_report_request_api_v1_report_requests__report_request_id___get","routeSlug":"/products/customer-api/reference/reports/get_customer_report_request_api_v1_report_requests__report_request_id___get","metadata":{"seo":{"title":"Get Customer Report Request","description":"This endpoint retrieves the details of a specific report request, and returns a single ReportRequest object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_customer_report_request_api_v1_report_requests__report_request_id___get","name":"Get Customer Report Request","isWebhook":false,"pointer":"/paths/~1api~1v1~1report-requests~1{report_request_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Customer Report Request","badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves the details of a specific report request, and returns a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ReportRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["reports.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_request_id","in":"path","schemaId":"schema_293","required":true}],"pointer":"/paths/~1api~1v1~1report-requests~1{report_request_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/report-requests/{report_request_id}/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"report_request_id","in":"path","required":true,"schemaId":"schema_293"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["reports.read"]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/report-requests/{report_request_id}/","href":"reports/get_customer_report_request_api_v1_report_requests__report_request_id___get","openApiOperationId":"get_customer_report_request_api_v1_report_requests__report_request_id___get","summary":"Get Customer Report Request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportRequest"}},"schemaId":"components/schemas/ReportRequest"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1report-requests~1{report_request_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportRequest"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/get_customer_report_request_api_v1_report_requests__report_request_id___get"}],"panels":[]}]},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v1/report-requests/{report_request_id}/"},{"label":"Get Customer Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/reports/get_customer_report_api_v1_reports__report_id___get","routeSlug":"/products/customer-api/reference/reports/get_customer_report_api_v1_reports__report_id___get","metadata":{"seo":{"title":"Get Customer Report","description":"This endpoint retrieves the details of a specific report, and returns a single Report object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_customer_report_api_v1_reports__report_id___get","name":"Get Customer Report","isWebhook":false,"pointer":"/paths/~1api~1v1~1reports~1{report_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Customer Report","badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves the details of a specific report, and returns a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Report"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["reports.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_id","in":"path","schemaId":"schema_294","required":true}],"pointer":"/paths/~1api~1v1~1reports~1{report_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/reports/{report_id}/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"report_id","in":"path","required":true,"schemaId":"schema_294"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["reports.read"]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/reports/{report_id}/","href":"reports/get_customer_report_api_v1_reports__report_id___get","openApiOperationId":"get_customer_report_api_v1_reports__report_id___get","summary":"Get Customer Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Report"}},"schemaId":"components/schemas/Report"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1reports~1{report_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Report","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Report"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/get_customer_report_api_v1_reports__report_id___get"}],"panels":[]}]},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v1/reports/{report_id}/"},{"label":"Download Customer Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/reports/download_customer_report_api_v1_reports__report_id__download__post","routeSlug":"/products/customer-api/reference/reports/download_customer_report_api_v1_reports__report_id__download__post","metadata":{"seo":{"title":"Download Customer Report","description":"This endpoint creates a temporary, time-limited URL for downloading the report corresponding to the given id, and returns a single ReportDownload object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"download_customer_report_api_v1_reports__report_id__download__post","name":"Download Customer Report","isWebhook":false,"pointer":"/paths/~1api~1v1~1reports~1{report_id}~1download~1/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download Customer Report","badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint creates a temporary, time-limited URL for downloading the report corresponding to the given id, and returns a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ReportDownload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["reports.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_id","in":"path","schemaId":"schema_294","required":true}],"pointer":"/paths/~1api~1v1~1reports~1{report_id}~1download~1/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/reports/{report_id}/download/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"report_id","in":"path","required":true,"schemaId":"schema_294"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["reports.read"]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/reports/{report_id}/download/","href":"reports/download_customer_report_api_v1_reports__report_id__download__post","openApiOperationId":"download_customer_report_api_v1_reports__report_id__download__post","summary":"Download Customer Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportDownload"}},"schemaId":"components/schemas/ReportDownload"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1reports~1{report_id}~1download~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportDownload","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportDownload"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/download_customer_report_api_v1_reports__report_id__download__post"}],"panels":[]}]},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v1/reports/{report_id}/download/"}],"content":{"contentType":"group","meta":{"name":"Reports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reports","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ Experimental ⚠️"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" These endpoints are subject to change."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these endpoints to interact with Reports."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/report-requests/","summary":"Create Customer Report Request","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"link":"/reports/create_customer_report_request_api_v1_report_requests__post","deprecated":false},{"title":"/api/v1/report-requests/","summary":"List Customer Report Requests","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"link":"/reports/list_customer_report_requests_api_v1_report_requests__get","deprecated":false},{"title":"/api/v1/report-requests/{report_request_id}/","summary":"Get Customer Report Request","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"link":"/reports/get_customer_report_request_api_v1_report_requests__report_request_id___get","deprecated":false},{"title":"/api/v1/reports/{report_id}/","summary":"Get Customer Report","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"link":"/reports/get_customer_report_api_v1_reports__report_id___get","deprecated":false},{"title":"/api/v1/reports/{report_id}/download/","summary":"Download Customer Report","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"link":"/reports/download_customer_report_api_v1_reports__report_id__download__post","deprecated":false}]}]}]}]}},{"type":"separator","label":"Users & Team Members","content":null},{"type":"group","label":"User","link":"/products/customer-api/reference/user","routeSlug":"/products/customer-api/reference/user","items":[{"label":"Get User Info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/user/get_user_info_api_v1_user__get","routeSlug":"/products/customer-api/reference/user/get_user_info_api_v1_user__get","metadata":{"seo":{"title":"Get User Info","description":"This endpoint retrieves information about the currently authenticated user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_user_info_api_v1_user__get","name":"Get User Info","isWebhook":false,"pointer":"/paths/~1api~1v1~1user~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get User Info","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves information about the currently authenticated user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UserInfo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object containing the user's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"role"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and other details."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/user/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/v1/user/","href":"user/get_user_info_api_v1_user__get","openApiOperationId":"get_user_info_api_v1_user__get","summary":"Get User Info"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserInfo"}},"schemaId":"components/schemas/UserInfo"}],"pointer":"/paths/~1api~1v1~1user~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserInfo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserInfo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/get_user_info_api_v1_user__get"}],"panels":[]}]},"httpPath":"/api/v1/user/"},{"label":"Get Memberships","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/user/get-user-memberships","routeSlug":"/products/customer-api/reference/user/get-user-memberships","metadata":{"seo":{"title":"Get Memberships","description":"This endpoint retrieves all team memberships for the currently authenticated user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-user-memberships","name":"Get Memberships","isWebhook":false,"pointer":"/paths/~1api~1v1~1user~1memberships~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Memberships","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves all team memberships for the currently authenticated user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It returns a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MembershipInfo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects, each detailing a team and the user's role within it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/user/memberships/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/v1/user/memberships/","href":"user/get-user-memberships","openApiOperationId":"get-user-memberships","summary":"Get Memberships"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_295"}},"schemaId":"schema_295"}],"pointer":"/paths/~1api~1v1~1user~1memberships~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_295","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_295"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/get-user-memberships"}],"panels":[]}]},"httpPath":"/api/v1/user/memberships/"}],"content":{"contentType":"group","meta":{"name":"User"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to view User information."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/user/","summary":"Get User Info","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user/get_user_info_api_v1_user__get","deprecated":false},{"title":"/api/v1/user/memberships/","summary":"Get Memberships","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user/get-user-memberships","deprecated":false}]}]}]}]}},{"type":"group","label":"Team","link":"/products/customer-api/reference/team","routeSlug":"/products/customer-api/reference/team","items":[{"label":"Get Team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/team/get_team_api_v1_team__get","routeSlug":"/products/customer-api/reference/team/get_team_api_v1_team__get","metadata":{"seo":{"title":"Get Team","description":"This endpoint retrieves information about the team, including a list of all team members."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_team_api_v1_team__get","name":"Get Team","isWebhook":false,"pointer":"/paths/~1api~1v1~1team~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Team","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves information about the team, including a list of all team members."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TeamResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object which contains the team ID and a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MemberGroup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects, categorized by member status ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc.)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["team.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/team/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["team.read"]}],"responseCodes":["200"],"pointer":"/api/v1/team/","href":"team/get_team_api_v1_team__get","openApiOperationId":"get_team_api_v1_team__get","summary":"Get Team"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TeamResponse"}},"schemaId":"components/schemas/TeamResponse"}],"pointer":"/paths/~1api~1v1~1team~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TeamResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TeamResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/team/get_team_api_v1_team__get"}],"panels":[]}]},"httpPath":"/api/v1/team/"},{"label":"Get Team Member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/team/get_team_member_api_v1_team__member_id___get","routeSlug":"/products/customer-api/reference/team/get_team_member_api_v1_team__member_id___get","metadata":{"seo":{"title":"Get Team Member","description":"This endpoint retrieves the details of a specific team member, and returns a TeamMemberResponse object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_team_member_api_v1_team__member_id___get","name":"Get Team Member","isWebhook":false,"pointer":"/paths/~1api~1v1~1team~1{member_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Team Member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves the details of a specific team member, and returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TeamMemberResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["team.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"member_id","in":"path","schemaId":"schema_296","required":true}],"pointer":"/paths/~1api~1v1~1team~1{member_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/team/{member_id}/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"member_id","in":"path","required":true,"schemaId":"schema_296"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["team.read"]}],"responseCodes":["200","422"],"pointer":"/api/v1/team/{member_id}/","href":"team/get_team_member_api_v1_team__member_id___get","openApiOperationId":"get_team_member_api_v1_team__member_id___get","summary":"Get Team Member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TeamMemberResponse"}},"schemaId":"components/schemas/TeamMemberResponse"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1team~1{member_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TeamMemberResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TeamMemberResponse"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/team/get_team_member_api_v1_team__member_id___get"}],"panels":[]}]},"httpPath":"/api/v1/team/{member_id}/"},{"label":"Edit Team Member","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/team/edit_team_member_api_v1_team__member_id___put","routeSlug":"/products/customer-api/reference/team/edit_team_member_api_v1_team__member_id___put","metadata":{"seo":{"title":"Edit Team Member","description":"This endpoint allows you to edit a team member's role or status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"edit_team_member_api_v1_team__member_id___put","name":"Edit Team Member","isWebhook":false,"pointer":"/paths/~1api~1v1~1team~1{member_id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit Team Member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to edit a team member's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"role"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body takes an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EditTeamMemberRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, and returns the updated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TeamMemberResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["team.write"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"member_id","in":"path","schemaId":"schema_296","required":true}],"pointer":"/paths/~1api~1v1~1team~1{member_id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EditTeamMemberRequest"}},"schemaId":"components/schemas/EditTeamMemberRequest","pointer":"/paths/~1api~1v1~1team~1{member_id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/team/{member_id}/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"member_id","in":"path","required":true,"schemaId":"schema_296"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["team.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EditTeamMemberRequest"}},"responseCodes":["202","422"],"pointer":"/api/v1/team/{member_id}/","href":"team/edit_team_member_api_v1_team__member_id___put","openApiOperationId":"edit_team_member_api_v1_team__member_id___put","summary":"Edit Team Member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"schemaId":"components/schemas/EditTeamMemberRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EditTeamMemberRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}},"schemaId":"schema_267"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1team~1{member_id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_267","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/team/edit_team_member_api_v1_team__member_id___put"}],"panels":[]}]},"httpPath":"/api/v1/team/{member_id}/"},{"label":"Deactivate Team Member","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/team/deactivate_team_member_api_v1_team__member_id___delete","routeSlug":"/products/customer-api/reference/team/deactivate_team_member_api_v1_team__member_id___delete","metadata":{"seo":{"title":"Deactivate Team Member","description":"This endpoint deactivates a team member from a team, and returns the TeamMemberResponse object for the deactivated member."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deactivate_team_member_api_v1_team__member_id___delete","name":"Deactivate Team Member","isWebhook":false,"pointer":"/paths/~1api~1v1~1team~1{member_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate Team Member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint deactivates a team member from a team, and returns the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TeamMemberResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object for the deactivated member."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["team.write"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"member_id","in":"path","schemaId":"schema_296","required":true}],"pointer":"/paths/~1api~1v1~1team~1{member_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/team/{member_id}/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"member_id","in":"path","required":true,"schemaId":"schema_296"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["team.write"]}],"responseCodes":["202","422"],"pointer":"/api/v1/team/{member_id}/","href":"team/deactivate_team_member_api_v1_team__member_id___delete","openApiOperationId":"deactivate_team_member_api_v1_team__member_id___delete","summary":"Deactivate Team Member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}},"schemaId":"schema_267"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1team~1{member_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_267","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/team/deactivate_team_member_api_v1_team__member_id___delete"}],"panels":[]}]},"httpPath":"/api/v1/team/{member_id}/"},{"label":"Invite Team Member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/team/invite_team_member_api_v1_team_invite__post","routeSlug":"/products/customer-api/reference/team/invite_team_member_api_v1_team_invite__post","metadata":{"seo":{"title":"Invite Team Member","description":"This endpoint invites a new member to a team."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"invite_team_member_api_v1_team_invite__post","name":"Invite Team Member","isWebhook":false,"pointer":"/paths/~1api~1v1~1team~1invite~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invite Team Member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint invites a new member to a team."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body requires an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InviteMemberRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object containing the new member's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"role"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["team.write"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InviteMemberRequest"}},"schemaId":"components/schemas/InviteMemberRequest","pointer":"/paths/~1api~1v1~1team~1invite~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/team/invite/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["team.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InviteMemberRequest"}},"responseCodes":["202","422"],"pointer":"/api/v1/team/invite/","href":"team/invite_team_member_api_v1_team_invite__post","openApiOperationId":"invite_team_member_api_v1_team_invite__post","summary":"Invite Team Member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"schemaId":"components/schemas/InviteMemberRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InviteMemberRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}},"schemaId":"schema_267"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1team~1invite~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_267","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/team/invite_team_member_api_v1_team_invite__post"}],"panels":[]}]},"httpPath":"/api/v1/team/invite/"},{"label":"Resend Invite Team Member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/team/resend_invite_team_member_api_v1_team__member_id__invite__post","routeSlug":"/products/customer-api/reference/team/resend_invite_team_member_api_v1_team__member_id__invite__post","metadata":{"seo":{"title":"Resend Invite Team Member","description":"This endpoint resends an invitation to a team member, and returns a 200 OK response upon a successful request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"resend_invite_team_member_api_v1_team__member_id__invite__post","name":"Resend Invite Team Member","isWebhook":false,"pointer":"/paths/~1api~1v1~1team~1{member_id}~1invite~1/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend Invite Team Member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint resends an invitation to a team member, and returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200 OK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response upon a successful request."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["team.write"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"member_id","in":"path","schemaId":"schema_296","required":true}],"pointer":"/paths/~1api~1v1~1team~1{member_id}~1invite~1/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/team/{member_id}/invite/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"member_id","in":"path","required":true,"schemaId":"schema_296"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["team.write"]}],"responseCodes":["200","422"],"pointer":"/api/v1/team/{member_id}/invite/","href":"team/resend_invite_team_member_api_v1_team__member_id__invite__post","openApiOperationId":"resend_invite_team_member_api_v1_team__member_id__invite__post","summary":"Resend Invite Team Member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}},"schemaId":"schema_267"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1team~1{member_id}~1invite~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_267","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/team/resend_invite_team_member_api_v1_team__member_id__invite__post"}],"panels":[]}]},"httpPath":"/api/v1/team/{member_id}/invite/"},{"label":"Cancel Invite Team Member","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/team/cancel_invite_team_member_api_v1_team__member_id__invite__delete","routeSlug":"/products/customer-api/reference/team/cancel_invite_team_member_api_v1_team__member_id__invite__delete","metadata":{"seo":{"title":"Cancel Invite Team Member","description":"This endpoint cancels an invitation that has been sent to a team member, and returns a 200 OK response upon a successful request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancel_invite_team_member_api_v1_team__member_id__invite__delete","name":"Cancel Invite Team Member","isWebhook":false,"pointer":"/paths/~1api~1v1~1team~1{member_id}~1invite~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel Invite Team Member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint cancels an invitation that has been sent to a team member, and returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200 OK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response upon a successful request."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["team.write"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"member_id","in":"path","schemaId":"schema_296","required":true}],"pointer":"/paths/~1api~1v1~1team~1{member_id}~1invite~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/team/{member_id}/invite/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"member_id","in":"path","required":true,"schemaId":"schema_296"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["team.write"]}],"responseCodes":["200","422"],"pointer":"/api/v1/team/{member_id}/invite/","href":"team/cancel_invite_team_member_api_v1_team__member_id__invite__delete","openApiOperationId":"cancel_invite_team_member_api_v1_team__member_id__invite__delete","summary":"Cancel Invite Team Member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}},"schemaId":"schema_267"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1team~1{member_id}~1invite~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_267","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/team/cancel_invite_team_member_api_v1_team__member_id__invite__delete"}],"panels":[]}]},"httpPath":"/api/v1/team/{member_id}/invite/"},{"label":"Create Service User","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/team/create_service_user_api_v1_team_service_users__post","routeSlug":"/products/customer-api/reference/team/create_service_user_api_v1_team_service_users__post","metadata":{"seo":{"title":"Create Service User","description":"Create Service User"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_service_user_api_v1_team_service_users__post","name":"Create Service User","isWebhook":false,"pointer":"/paths/~1api~1v1~1team~1service-users~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Service User","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["team.write"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateServiceUserRequest"}},"schemaId":"components/schemas/CreateServiceUserRequest","pointer":"/paths/~1api~1v1~1team~1service-users~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/team/service-users/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["team.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateServiceUserRequest"}},"responseCodes":["202","422"],"pointer":"/api/v1/team/service-users/","href":"team/create_service_user_api_v1_team_service_users__post","openApiOperationId":"create_service_user_api_v1_team_service_users__post","summary":"Create Service User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"schemaId":"components/schemas/CreateServiceUserRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateServiceUserRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}},"schemaId":"schema_267"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1team~1service-users~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_267","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/team/create_service_user_api_v1_team_service_users__post"}],"panels":[]}]},"httpPath":"/api/v1/team/service-users/"}],"content":{"contentType":"group","meta":{"name":"Team"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Team","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to view and manage details for a Team and its members."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/team/","summary":"Get Team","prefix":{"name":"get","color":"get"},"badges":[],"link":"/team/get_team_api_v1_team__get","deprecated":false},{"title":"/api/v1/team/{member_id}/","summary":"Get Team Member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/team/get_team_member_api_v1_team__member_id___get","deprecated":false},{"title":"/api/v1/team/{member_id}/","summary":"Edit Team Member","prefix":{"name":"put","color":"put"},"badges":[],"link":"/team/edit_team_member_api_v1_team__member_id___put","deprecated":false},{"title":"/api/v1/team/{member_id}/","summary":"Deactivate Team Member","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/team/deactivate_team_member_api_v1_team__member_id___delete","deprecated":false},{"title":"/api/v1/team/invite/","summary":"Invite Team Member","prefix":{"name":"post","color":"post"},"badges":[],"link":"/team/invite_team_member_api_v1_team_invite__post","deprecated":false},{"title":"/api/v1/team/{member_id}/invite/","summary":"Resend Invite Team Member","prefix":{"name":"post","color":"post"},"badges":[],"link":"/team/resend_invite_team_member_api_v1_team__member_id__invite__post","deprecated":false},{"title":"/api/v1/team/{member_id}/invite/","summary":"Cancel Invite Team Member","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/team/cancel_invite_team_member_api_v1_team__member_id__invite__delete","deprecated":false},{"title":"/api/v1/team/service-users/","summary":"Create Service User","prefix":{"name":"post","color":"post"},"badges":[],"link":"/team/create_service_user_api_v1_team_service_users__post","deprecated":false}]}]}]}]}},{"type":"group","label":"Team Audits","link":"/products/customer-api/reference/team-audits","routeSlug":"/products/customer-api/reference/team-audits","items":[{"label":"Get Team Audit Logs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/team-audits/get_team_audit_logs_api_v1_team_audit_logs__get","routeSlug":"/products/customer-api/reference/team-audits/get_team_audit_logs_api_v1_team_audit_logs__get","metadata":{"seo":{"title":"Get Team Audit Logs","description":"This endpoint retrieves audit logs for the entire team. This is useful for tracking actions performed by team members."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_team_audit_logs_api_v1_team_audit_logs__get","name":"Get Team Audit Logs","isWebhook":false,"pointer":"/paths/~1api~1v1~1team~1audit-logs~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Team Audit Logs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves audit logs for the entire team. This is useful for tracking actions performed by team members."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It returns a paginated list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerAuditLogEntry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects, which can be filtered by a time range."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["team.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_297"},{"name":"limit","in":"query","schemaId":"schema_298"},{"name":"timestamp_from","in":"query","schemaId":"schema_299"},{"name":"timestamp_to","in":"query","schemaId":"schema_300"}],"pointer":"/paths/~1api~1v1~1team~1audit-logs~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/team/audit-logs/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_297"},{"name":"limit","in":"query","required":false,"schemaId":"schema_298"},{"name":"timestamp_from","in":"query","required":false,"schemaId":"schema_299"},{"name":"timestamp_to","in":"query","required":false,"schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["team.read"]}],"responseCodes":["200","422"],"pointer":"/api/v1/team/audit-logs/","href":"team-audits/get_team_audit_logs_api_v1_team_audit_logs__get","openApiOperationId":"get_team_audit_logs_api_v1_team_audit_logs__get","summary":"Get Team Audit Logs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerAuditLogResults"}},"schemaId":"components/schemas/CustomerAuditLogResults"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1team~1audit-logs~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerAuditLogResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerAuditLogResults"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/team-audits/get_team_audit_logs_api_v1_team_audit_logs__get"}],"panels":[]}]},"httpPath":"/api/v1/team/audit-logs/"},{"label":"Get Team Member Audit Logs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/team-audits/get_team_member_audit_logs_api_v1_team_members__member_id__audit_logs__get","routeSlug":"/products/customer-api/reference/team-audits/get_team_member_audit_logs_api_v1_team_members__member_id__audit_logs__get","metadata":{"seo":{"title":"Get Team Member Audit Logs","description":"This endpoint retrieves audit logs for a specific team member, and returns a paginated list of CustomerAuditLogEntry objects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_team_member_audit_logs_api_v1_team_members__member_id__audit_logs__get","name":"Get Team Member Audit Logs","isWebhook":false,"pointer":"/paths/~1api~1v1~1team~1members~1{member_id}~1audit-logs~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Team Member Audit Logs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves audit logs for a specific team member, and returns a paginated list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomerAuditLogEntry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["team.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"member_id","in":"path","schemaId":"schema_296","required":true}],"pointer":"/paths/~1api~1v1~1team~1members~1{member_id}~1audit-logs~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_297"},{"name":"limit","in":"query","schemaId":"schema_298"},{"name":"timestamp_from","in":"query","schemaId":"schema_299"},{"name":"timestamp_to","in":"query","schemaId":"schema_300"}],"pointer":"/paths/~1api~1v1~1team~1members~1{member_id}~1audit-logs~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/team/members/{member_id}/audit-logs/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"member_id","in":"path","required":true,"schemaId":"schema_296"}],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_297"},{"name":"limit","in":"query","required":false,"schemaId":"schema_298"},{"name":"timestamp_from","in":"query","required":false,"schemaId":"schema_299"},{"name":"timestamp_to","in":"query","required":false,"schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["team.read"]}],"responseCodes":["200","422"],"pointer":"/api/v1/team/members/{member_id}/audit-logs/","href":"team-audits/get_team_member_audit_logs_api_v1_team_members__member_id__audit_logs__get","openApiOperationId":"get_team_member_audit_logs_api_v1_team_members__member_id__audit_logs__get","summary":"Get Team Member Audit Logs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerAuditLogResults"}},"schemaId":"components/schemas/CustomerAuditLogResults"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1team~1members~1{member_id}~1audit-logs~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerAuditLogResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerAuditLogResults"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/team-audits/get_team_member_audit_logs_api_v1_team_members__member_id__audit_logs__get"}],"panels":[]}]},"httpPath":"/api/v1/team/members/{member_id}/audit-logs/"},{"label":"Team Audits As Csv","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/team-audits/team_audits_as_csv_api_v1_team_audit_logs_csv_get","routeSlug":"/products/customer-api/reference/team-audits/team_audits_as_csv_api_v1_team_audit_logs_csv_get","metadata":{"seo":{"title":"Team Audits As Csv","description":"This endpoint downloads team audit logs in CSV format for offline analysis and record-keeping, and can be filtered by member_id and a timestamp range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"team_audits_as_csv_api_v1_team_audit_logs_csv_get","name":"Team Audits As Csv","isWebhook":false,"pointer":"/paths/~1api~1v1~1team~1audit-logs.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Team Audits As Csv","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint downloads team audit logs in CSV format for offline analysis and record-keeping, and can be filtered by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"member_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a timestamp range."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["team.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"member_id","in":"query","schemaId":"schema_301"},{"name":"timestamp_from","in":"query","schemaId":"schema_299"},{"name":"timestamp_to","in":"query","schemaId":"schema_300"}],"pointer":"/paths/~1api~1v1~1team~1audit-logs.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/team/audit-logs.csv","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"member_id","in":"query","required":false,"schemaId":"schema_301"},{"name":"timestamp_from","in":"query","required":false,"schemaId":"schema_299"},{"name":"timestamp_to","in":"query","required":false,"schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["team.read"]}],"responseCodes":["200","422"],"pointer":"/api/v1/team/audit-logs.csv","href":"team-audits/team_audits_as_csv_api_v1_team_audit_logs_csv_get","openApiOperationId":"team_audits_as_csv_api_v1_team_audit_logs_csv_get","summary":"Team Audits As Csv"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerAuditLogResults"}},"schemaId":"components/schemas/CustomerAuditLogResults"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1team~1audit-logs.csv/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerAuditLogResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerAuditLogResults"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/team-audits/team_audits_as_csv_api_v1_team_audit_logs_csv_get"}],"panels":[]}]},"httpPath":"/api/v1/team/audit-logs.csv"}],"content":{"contentType":"group","meta":{"name":"Team Audits"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Team Audits","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/team/audit-logs/","summary":"Get Team Audit Logs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/team-audits/get_team_audit_logs_api_v1_team_audit_logs__get","deprecated":false},{"title":"/api/v1/team/members/{member_id}/audit-logs/","summary":"Get Team Member Audit Logs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/team-audits/get_team_member_audit_logs_api_v1_team_members__member_id__audit_logs__get","deprecated":false},{"title":"/api/v1/team/audit-logs.csv","summary":"Team Audits As Csv","prefix":{"name":"get","color":"get"},"badges":[],"link":"/team-audits/team_audits_as_csv_api_v1_team_audit_logs_csv_get","deprecated":false}]}]}]}]}},{"type":"separator","label":"Customer","content":null},{"type":"group","label":"Customer","link":"/products/customer-api/reference/customer","routeSlug":"/products/customer-api/reference/customer","items":[{"label":"Get Customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/customer/get_customer_api_v1_customer__get","routeSlug":"/products/customer-api/reference/customer/get_customer_api_v1_customer__get","metadata":{"seo":{"title":"Get Customer","description":"This endpoint retrieves the customer's profile information. This can be for an individual or a business."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_customer_api_v1_customer__get","name":"Get Customer","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves the customer's profile information. This can be for an individual or a business."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object which can be either an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Individual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Business"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, containing details like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["customer.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customer/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["customer.read"]}],"responseCodes":["200","404"],"pointer":"/api/v1/customer/","href":"customer/get_customer_api_v1_customer__get","openApiOperationId":"get_customer_api_v1_customer__get","summary":"Get Customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer"}},"schemaId":"components/schemas/Customer"},{"code":"404","description":"Not found"}],"pointer":"/paths/~1api~1v1~1customer~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Customer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer/get_customer_api_v1_customer__get"}],"panels":[]}]},"httpPath":"/api/v1/customer/"},{"label":"Upload Document To Customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/customer/upload_document_to_customer_api_v1_documents__document_type___post","routeSlug":"/products/customer-api/reference/customer/upload_document_to_customer_api_v1_documents__document_type___post","metadata":{"seo":{"title":"Upload Document To Customer","description":"This endpoint uploads a verification document (e.g., passport, articles of incorporation) directly to the customer's profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Upload_document_to_Customer_api_v1_documents__document_type___post","name":"Upload Document To Customer","isWebhook":false,"pointer":"/paths/~1api~1v1~1documents~1{document_type}~1/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload Document To Customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint uploads a verification document (e.g., passport, articles of incorporation) directly to the customer's profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"document_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified in the URL path. The raw file data is sent in the request body with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Length"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers. It returns the document's new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"document_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is mainly used to verify customer requests (e.g. Customer change request, close account request, ACH request)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["customer.write"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"document_type","in":"path","schemaId":"schema_302","required":true}],"pointer":"/paths/~1api~1v1~1documents~1{document_type}~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"content-type","in":"header","schemaId":"schema_303","required":true},{"name":"content-length","in":"header","schemaId":"schema_304","required":true}],"pointer":"/paths/~1api~1v1~1documents~1{document_type}~1/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/documents/{document_type}/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"document_type","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[{"name":"content-type","in":"header","required":true,"schemaId":"schema_303"},{"name":"content-length","in":"header","required":true,"schemaId":"schema_304"}],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["customer.write"]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/documents/{document_type}/","href":"customer/upload_document_to_customer_api_v1_documents__document_type___post","openApiOperationId":"Upload_document_to_Customer_api_v1_documents__document_type___post","summary":"Upload Document To Customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadDocumentResponse"}},"schemaId":"components/schemas/UploadDocumentResponse"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1documents~1{document_type}~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UploadDocumentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadDocumentResponse"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer/upload_document_to_customer_api_v1_documents__document_type___post"}],"panels":[]}]},"httpPath":"/api/v1/documents/{document_type}/"},{"label":"Get Beneficial Owners","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/customer/get_beneficial_owners_api_v1_customer_beneficial_owners__get","routeSlug":"/products/customer-api/reference/customer/get_beneficial_owners_api_v1_customer_beneficial_owners__get","metadata":{"seo":{"title":"Get Beneficial Owners","description":"For business customers, this endpoint lists the beneficial owners who have been identified for the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_beneficial_owners_api_v1_customer_beneficial_owners__get","name":"Get Beneficial Owners","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1beneficial-owners~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Beneficial Owners","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For business customers, this endpoint lists the beneficial owners who have been identified for the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ListBeneficialOwnersResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object containing a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BusinessIndividual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":["customer.read"],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customer/beneficial-owners/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":["customer.read"]}],"responseCodes":["200","404"],"pointer":"/api/v1/customer/beneficial-owners/","href":"customer/get_beneficial_owners_api_v1_customer_beneficial_owners__get","openApiOperationId":"get_beneficial_owners_api_v1_customer_beneficial_owners__get","summary":"Get Beneficial Owners"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBeneficialOwnersResponse"}},"schemaId":"components/schemas/ListBeneficialOwnersResponse"},{"code":"404","description":"Not found"}],"pointer":"/paths/~1api~1v1~1customer~1beneficial-owners~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListBeneficialOwnersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBeneficialOwnersResponse"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer/get_beneficial_owners_api_v1_customer_beneficial_owners__get"}],"panels":[]}]},"httpPath":"/api/v1/customer/beneficial-owners/"}],"content":{"contentType":"group","meta":{"name":"Customer"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to view and manage personal details for a Customer."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/customer/","summary":"Get Customer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer/get_customer_api_v1_customer__get","deprecated":false},{"title":"/api/v1/documents/{document_type}/","summary":"Upload Document To Customer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customer/upload_document_to_customer_api_v1_documents__document_type___post","deprecated":false},{"title":"/api/v1/customer/beneficial-owners/","summary":"Get Beneficial Owners","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer/get_beneficial_owners_api_v1_customer_beneficial_owners__get","deprecated":false}]}]}]}]}},{"type":"group","label":"Agreements","link":"/products/customer-api/reference/agreements","routeSlug":"/products/customer-api/reference/agreements","items":[{"label":"List Agreements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/agreements/list_agreements_api_v1_agreements__get","routeSlug":"/products/customer-api/reference/agreements/list_agreements_api_v1_agreements__get","metadata":{"seo":{"title":"List Agreements","description":"This endpoint retrieves a list of legal agreements that a customer can acknowledge. These agreements could include terms of service, privacy policies, or other legal documents."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_agreements_api_v1_agreements__get","name":"List Agreements","isWebhook":false,"pointer":"/paths/~1api~1v1~1agreements~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Agreements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves a list of legal agreements that a customer can acknowledge. These agreements could include terms of service, privacy policies, or other legal documents."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It returns an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Agreement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object which contains the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"release_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and a list of documents. Each document includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pdf_download_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"category"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"CodeBearer","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/agreements/","servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/v1/agreements/","href":"agreements/list_agreements_api_v1_agreements__get","openApiOperationId":"list_agreements_api_v1_agreements__get","summary":"List Agreements"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Agreement"}},"schemaId":"components/schemas/Agreement"}],"pointer":"/paths/~1api~1v1~1agreements~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Agreement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Agreement"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agreements/list_agreements_api_v1_agreements__get"}],"panels":[]}]},"httpPath":"/api/v1/agreements/"}],"content":{"contentType":"group","meta":{"name":"Agreements"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Agreements","showPageActions":true},{"nodeType":"markdoc","content":"Use this endpoint to fetch Agreements specific to your institution and Jiko."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/agreements/","summary":"List Agreements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agreements/list_agreements_api_v1_agreements__get","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ACHCounterpartyV2":{"id":"components/schemas/ACHCounterpartyV2","kind":"json-schema","title":"ACH Counterparty","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"status":{"type":"string","enum":["PENDING","FAILED","LINKED","UNLINKED","CLOSED"],"title":"Status"},"verification":{"oneOf":[{"$ref":"#/components/schemas/SupportingDocumentsVerification"},{"$ref":"#/components/schemas/IncomingWireVerification"},{"$ref":"#/components/schemas/PreVerifiedVerification"},{"$ref":"#/components/schemas/PlaidVerification"},{"$ref":"#/components/schemas/MicroDepositsVerification"},{"$ref":"#/components/schemas/NameMatchVerification"},{"$ref":"#/components/schemas/UnverifiedVerification"}],"title":"Verification","discriminator":{"propertyName":"type","mapping":{"incoming_wire":"#/components/schemas/IncomingWireVerification","micro_deposits":"#/components/schemas/MicroDepositsVerification","name_match":"#/components/schemas/NameMatchVerification","plaid":"#/components/schemas/PlaidVerification","pre_verified":"#/components/schemas/PreVerifiedVerification","supporting_documents":"#/components/schemas/SupportingDocumentsVerification","unverified":"#/components/schemas/UnverifiedVerification"}}},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name","description":"An optional custom display name for the counterparty, useful for distinguishing multiple counterparties that share the same legal name."},"type":{"type":"string","const":"ach","title":"Type"},"counterparty_name":{"type":"string","title":"Counterparty Name"},"institution_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Institution Name"},"routing_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Routing Number"},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number"},"account_type":{"type":"string","enum":["CHECKING","SAVINGS"],"title":"Account Type"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","time_created","status","verification","type","counterparty_name","institution_name","routing_number","account_number","account_type","object_type"],"title":"ACH Counterparty"}},"components/schemas/ACHDirection":{"id":"components/schemas/ACHDirection","kind":"json-schema","title":"ACHDirection","data":{"type":"string","enum":["RECEIVING","ORIGINATION"],"title":"ACHDirection"}},"components/schemas/ACHFundingInstruction":{"id":"components/schemas/ACHFundingInstruction","kind":"json-schema","title":"ACHFundingInstruction","data":{"properties":{"type":{"type":"string","const":"ACH","title":"Type"},"routing_number":{"type":"string","title":"Routing Number","description":"ABA routing number"},"account_number":{"type":"string","title":"Account Number","description":"Account number"},"account_type":{"type":"string","title":"Account Type","description":"Account type"}},"type":"object","required":["type","routing_number","account_number","account_type"],"title":"ACHFundingInstruction"}},"components/schemas/ACHTransactionActivity":{"id":"components/schemas/ACHTransactionActivity","kind":"json-schema","title":"ACHTransactionActivity","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The ID of the transaction from the perspective of the respective pocket"},"transaction_id":{"type":"string","format":"uuid","title":"Transaction Id","description":"The ID of the transaction this activity is representing"},"description":{"type":"string","title":"Description","description":"A description of the transaction type, e.g. \"ACH Electronic Debit\"."},"amount":{"$ref":"#/components/schemas/Amount"},"time_booked":{"type":"string","format":"date-time","title":"Time Booked","description":"The time at which the transaction was originally booked into the ledger."},"time_settled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Time Settled","description":"The time at which transaction was settled."},"status":{"type":"string","enum":["BOOKED","SETTLED"],"title":"Status","description":"Status of the transactions. Has the transactions been settled"},"title":{"type":"string","title":"Title"},"direction":{"type":"string","enum":["DEBIT","CREDIT"],"title":"Direction"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":"The pocket associated with the transaction"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"The customer associated with the transaction"},"remittance_information":{"anyOf":[{"$ref":"#/components/schemas/RemittanceInformation"},{"type":"null"}]},"type":{"type":"string","const":"ACH","title":"Type"},"company_name":{"type":"string","title":"Company Name"},"company_entry_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Entry Description"},"individual_identification_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Individual Identification Number"},"trace_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trace Number"},"ach_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Ach Id"},"ach_direction":{"$ref":"#/components/schemas/ACHDirection"},"portal_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Portal Id"}},"type":"object","required":["id","transaction_id","description","amount","time_booked","time_settled","status","title","direction","pocket_id","customer_id","type","company_name","ach_direction"],"title":"ACHTransactionActivity"}},"components/schemas/AUMFee":{"id":"components/schemas/AUMFee","kind":"json-schema","title":"AUMFee","data":{"properties":{"amount":{"$ref":"#/components/schemas/Amount"},"type":{"type":"string","const":"AUM_FEE","title":"Type"}},"type":"object","required":["amount","type"],"title":"AUMFee"}},"components/schemas/Agreement":{"id":"components/schemas/Agreement","kind":"json-schema","title":"Agreement","data":{"properties":{"version":{"type":"string","title":"Version"},"release_date":{"type":"string","format":"date","title":"Release Date"},"documents":{"items":{"$ref":"#/components/schemas/AgreementDocument"},"type":"array","title":"Documents"}},"type":"object","required":["version","release_date","documents"],"title":"Agreement"}},"components/schemas/AgreementConsent":{"id":"components/schemas/AgreementConsent","kind":"json-schema","title":"AgreementConsent","data":{"properties":{"version":{"type":"string","title":"Version","description":"Agreement version"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"Timestamp of applicant's acknowledgement of the agreements"}},"type":"object","required":["version","timestamp"],"title":"AgreementConsent"}},"components/schemas/AgreementDocument":{"id":"components/schemas/AgreementDocument","kind":"json-schema","title":"AgreementDocument","data":{"properties":{"pdf_download_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Pdf Download Url"},"title":{"type":"string","title":"Title"},"type":{"type":"string","enum":["PRIVACY_POLICY","PRIVACY_NOTICE","BUSINESS_CONTINUITY_PLAN","FINANCIAL_STATEMENT","US_TREASURIES_RISK","ELECTRONIC_COMMUNICATIONS","TAX_CERTIFICATION_FOR_US_PERSON","BANK_ACCOUNT","LIMITATIONS","BROKERAGE","CARD","CASHBACK","FORM_CRS","AUTHORIZED_REPRESENTATIVE_CERTIFICATION","TERMS_OF_USE","ELECTRONIC_FUND_TRANSFERS","TRUTH_IN_SAVINGS","FEE_NOTICE","FUNDS_AVAILABILITY","REGULATION_E"],"title":"Type"},"category":{"type":"string","enum":["BANK","BROKERAGE","GENERAL","E-SIGN"],"title":"Category"}},"type":"object","required":["pdf_download_url","title","type","category"],"title":"AgreementDocument"}},"components/schemas/Amount":{"id":"components/schemas/Amount","kind":"json-schema","title":"Amount","data":{"properties":{"value":{"type":"integer","title":"Value","description":"USD values are always in cents."},"currency":{"type":"string","title":"Currency"},"formatted":{"type":"string","title":"Formatted","default":""}},"type":"object","required":["value","currency"],"title":"Amount"}},"components/schemas/ApplicationSubmissionInviteRequest":{"id":"components/schemas/ApplicationSubmissionInviteRequest","kind":"json-schema","title":"ApplicationSubmissionInviteRequest","data":{"properties":{"emails":{"items":{"type":"string"},"type":"array","title":"Emails"},"invitation_type":{"type":"string","const":"REQUEST_APPLICATION_SUBMISSION","title":"Invitation Type"}},"type":"object","required":["emails","invitation_type"],"title":"ApplicationSubmissionInviteRequest"}},"components/schemas/AuthenticationMethod":{"id":"components/schemas/AuthenticationMethod","kind":"json-schema","title":"AuthenticationMethod","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"type":{"$ref":"#/components/schemas/AuthenticationMethodType"},"sso_provider_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Sso Provider Id"}},"type":"object","required":["type"],"title":"AuthenticationMethod"}},"components/schemas/AuthenticationMethodType":{"id":"components/schemas/AuthenticationMethodType","kind":"json-schema","title":"AuthenticationMethodType","data":{"type":"string","enum":["SSO","USERPASS"],"title":"AuthenticationMethodType"}},"components/schemas/BankStatementReport":{"id":"components/schemas/BankStatementReport","kind":"json-schema","title":"BankStatementReport","data":{"properties":{"pocket_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Pocket Ids"},"date":{"type":"string","format":"date","title":"Date"},"type":{"type":"string","const":"BANK_STATEMENT_REPORT","title":"Type"}},"type":"object","required":["pocket_ids","date","type"],"title":"BankStatementReport"}},"components/schemas/Beneficiary":{"id":"components/schemas/Beneficiary","kind":"json-schema","title":"Beneficiary","data":{"properties":{"account_number":{"type":"string","title":"Account Number","description":"Beneficiary account number"},"name":{"type":"string","title":"Name","description":"Beneficiary name"},"address":{"type":"string","title":"Address","description":"Beneficiary address"}},"type":"object","required":["account_number","name","address"],"title":"Beneficiary"}},"components/schemas/BrokerageStatementReport":{"id":"components/schemas/BrokerageStatementReport","kind":"json-schema","title":"BrokerageStatementReport","data":{"properties":{"date":{"type":"string","format":"date","title":"Date"},"pocket_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Pocket Ids"},"type":{"type":"string","const":"BROKERAGE_STATEMENT_REPORT","title":"Type"}},"type":"object","required":["date","pocket_ids","type"],"title":"BrokerageStatementReport"}},"components/schemas/Business":{"id":"components/schemas/Business","kind":"json-schema","title":"Business","data":{"properties":{"address":{"$ref":"#/components/schemas/GeneralAddress"},"email":{"type":"string","title":"Email"},"phone_number":{"type":"string","title":"Phone Number"},"account_status":{"type":"string","enum":["OPEN","CLOSED","FROZEN","PENDING"],"title":"Account Status"},"type":{"type":"string","const":"BUSINESS","title":"Type"},"name":{"type":"string","title":"Name"},"identification_number":{"$ref":"#/components/schemas/BusinessIdentificationNumber"}},"type":"object","required":["address","email","phone_number","account_status","type","name","identification_number"],"title":"Business"}},"components/schemas/BusinessApplication":{"id":"components/schemas/BusinessApplication","kind":"json-schema","title":"BusinessApplication","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"exception_reasons":{"items":{"type":"string"},"type":"array","title":"Exception Reasons","default":[]},"customer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Customer Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until application status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]}]}]}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"entity_type":{"anyOf":[{"type":"string","enum":["SOLE_PROPRIETOR","CORPORATE","LLC","PARTNERSHIP","INCORPORATED_ASSOCIATION","UNINCORPORATED_ASSOCIATION","REGULATED_FINANCIAL_INSTITUTION","NON_BANK_FINANCIAL_INSTITUTION","NON_PROFIT","SPECIAL_PURPOSE_ACQUISITION_COMPANY","TRUST"]},{"type":"null"}],"title":"Entity Type"},"doing_business_as":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doing Business As"},"identification_number":{"anyOf":[{"$ref":"#/components/schemas/BusinessIdentificationNumber"},{"type":"null"}]},"address":{"anyOf":[{"$ref":"#/components/schemas/ISOAddress"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website"},"contact":{"anyOf":[{"$ref":"#/components/schemas/BusinessContact"},{"type":"null"}]},"formation_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Formation Date"},"risk_info":{"anyOf":[{"$ref":"#/components/schemas/RiskInfo"},{"type":"null"}]},"industry":{"anyOf":[{"$ref":"#/components/schemas/IndustryInfo"},{"type":"null"}]},"agreement_consent":{"anyOf":[{"$ref":"#/components/schemas/AgreementConsent"},{"type":"null"}]},"team_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Team Id"},"status":{"type":"string","enum":["CREATED","SUBMITTED","CLOSED","APPROVED","REJECTED","MANUAL_REVIEW","DOCUMENTS_NEEDED","PENDING","COMPLETED"],"title":"Status"}},"type":"object","required":["id","time_created","updated_at","status"],"title":"BusinessApplication"}},"components/schemas/BusinessApplicationRequest":{"id":"components/schemas/BusinessApplicationRequest","kind":"json-schema","title":"BusinessApplicationRequest","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"entity_type":{"anyOf":[{"type":"string","enum":["SOLE_PROPRIETOR","CORPORATE","LLC","PARTNERSHIP","INCORPORATED_ASSOCIATION","UNINCORPORATED_ASSOCIATION","REGULATED_FINANCIAL_INSTITUTION","NON_BANK_FINANCIAL_INSTITUTION","NON_PROFIT","SPECIAL_PURPOSE_ACQUISITION_COMPANY","TRUST"]},{"type":"null"}],"title":"Entity Type"},"doing_business_as":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doing Business As"},"identification_number":{"anyOf":[{"$ref":"#/components/schemas/BusinessIdentificationNumber"},{"type":"null"}]},"address":{"anyOf":[{"$ref":"#/components/schemas/ISOAddressRequest"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website"},"contact":{"anyOf":[{"$ref":"#/components/schemas/BusinessContact"},{"type":"null"}]},"formation_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Formation Date"},"risk_info":{"anyOf":[{"$ref":"#/components/schemas/RiskInfo"},{"type":"null"}]},"industry":{"anyOf":[{"$ref":"#/components/schemas/IndustryInfo"},{"type":"null"}]},"agreement_consent":{"anyOf":[{"$ref":"#/components/schemas/AgreementConsent"},{"type":"null"}]}},"type":"object","title":"BusinessApplicationRequest"}},"components/schemas/BusinessContact":{"id":"components/schemas/BusinessContact","kind":"json-schema","title":"BusinessContact","data":{"properties":{"name":{"anyOf":[{"$ref":"#/components/schemas/Name"},{"type":"null"}]},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"}},"type":"object","title":"BusinessContact"}},"components/schemas/BusinessIdentificationNumber":{"id":"components/schemas/BusinessIdentificationNumber","kind":"json-schema","title":"BusinessIdentificationNumber","data":{"properties":{"identification_number":{"type":"string","title":"Identification Number"},"issuing_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issuing Country","description":"A ISO-3166 Alpha-2 country code (Abbreviated. Example: \"US\")"},"type":{"type":"string","enum":["TIN","EIN","NON_US_BUSINESS_ID"],"title":"Type"}},"type":"object","required":["identification_number","type"],"title":"BusinessIdentificationNumber"}},"components/schemas/BusinessIndividual":{"id":"components/schemas/BusinessIndividual","kind":"json-schema","title":"BusinessIndividual","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"$ref":"#/components/schemas/Name"},"title":{"type":"string","title":"Title"}},"type":"object","required":["id","name","title"],"title":"BusinessIndividual"}},"components/schemas/BusinessName":{"id":"components/schemas/BusinessName","kind":"json-schema","title":"BusinessName","data":{"properties":{"business_name":{"type":"string","title":"Business Name","description":"The name of the business counterparty."},"type":{"type":"string","const":"business","title":"Type"}},"type":"object","required":["business_name","type"],"title":"BusinessName"}},"components/schemas/CardTransactionActivity":{"id":"components/schemas/CardTransactionActivity","kind":"json-schema","title":"CardTransactionActivity","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The ID of the transaction from the perspective of the respective pocket"},"transaction_id":{"type":"string","format":"uuid","title":"Transaction Id","description":"The ID of the transaction this activity is representing"},"description":{"type":"string","title":"Description","description":"A description of the transaction type, e.g. \"ACH Electronic Debit\"."},"amount":{"$ref":"#/components/schemas/Amount"},"time_booked":{"type":"string","format":"date-time","title":"Time Booked","description":"The time at which the transaction was originally booked into the ledger."},"time_settled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Time Settled","description":"The time at which transaction was settled."},"status":{"type":"string","enum":["BOOKED","SETTLED"],"title":"Status","description":"Status of the transactions. Has the transactions been settled"},"title":{"type":"string","title":"Title"},"direction":{"type":"string","enum":["DEBIT","CREDIT"],"title":"Direction"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":"The pocket associated with the transaction"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"The customer associated with the transaction"},"remittance_information":{"anyOf":[{"$ref":"#/components/schemas/RemittanceInformation"},{"type":"null"}]},"type":{"type":"string","const":"CARD","title":"Type"},"location":{"anyOf":[{"$ref":"#/components/schemas/TransactionLocation"},{"type":"null"}]},"counterparty":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty"},"terminal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Terminal Id"},"merchant_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Merchant Type"},"pre_authorization":{"type":"boolean","title":"Pre Authorization"},"issue_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issue Id"}},"type":"object","required":["id","transaction_id","description","amount","time_booked","time_settled","status","title","direction","pocket_id","customer_id","type","pre_authorization"],"title":"CardTransactionActivity"}},"components/schemas/CollaborateInviteRequest":{"id":"components/schemas/CollaborateInviteRequest","kind":"json-schema","title":"CollaborateInviteRequest","data":{"properties":{"emails":{"items":{"type":"string"},"type":"array","title":"Emails"},"invitation_type":{"type":"string","const":"COLLABORATE","title":"Invitation Type"}},"type":"object","required":["emails","invitation_type"],"title":"CollaborateInviteRequest"}},"components/schemas/Collaborator":{"id":"components/schemas/Collaborator","kind":"json-schema","title":"Collaborator","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"email":{"type":"string","title":"Email"}},"type":"object","required":["email"],"title":"Collaborator"}},"components/schemas/CounterpartyAddress":{"id":"components/schemas/CounterpartyAddress","kind":"json-schema","title":"CounterpartyAddress","data":{"properties":{"street_address":{"type":"string","maxLength":250,"title":"Street Address","description":"Street address"},"street_address2":{"anyOf":[{"type":"string","maxLength":250},{"type":"null"}],"title":"Street Address2","description":"Apartment, Suite, Box number, etc."},"city":{"type":"string","maxLength":250,"title":"City","description":"City / Town"},"postal_code":{"type":"string","maxLength":50,"title":"Postal Code","description":"Postal code / ZIP code"},"state":{"type":"string","title":"State","description":"State (Postal Abbreviations. Example: \"AL\", \"NJ\", \"OH\")"},"country":{"type":"string","title":"Country","description":"A ISO-3166 Alpha-2 country code (Abbreviated. Example: \"US\")"}},"type":"object","required":["street_address","city","postal_code","state","country"],"title":"CounterpartyAddress"}},"components/schemas/CounterpartyListResponseV2":{"id":"components/schemas/CounterpartyListResponseV2","kind":"json-schema","title":"CounterpartyListResponseV2","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"oneOf":[{"$ref":"#/components/schemas/ACHCounterpartyV2"},{"$ref":"#/components/schemas/WireCounterpartyV2"},{"$ref":"#/components/schemas/OnUsCounterpartyV2"},{"$ref":"#/components/schemas/InternationalWireCounterpartyV2"},{"$ref":"#/components/schemas/CryptoWalletAddressCounterpartyV2"}],"discriminator":{"propertyName":"type","mapping":{"ach":"#/components/schemas/ACHCounterpartyV2","crypto_wallet_address":"#/components/schemas/CryptoWalletAddressCounterpartyV2","international_wire":"#/components/schemas/InternationalWireCounterpartyV2","on_us":"#/components/schemas/OnUsCounterpartyV2","wire":"#/components/schemas/WireCounterpartyV2"}}},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"CounterpartyListResponseV2"}},"components/schemas/CreateACHCounterpartyRequest":{"id":"components/schemas/CreateACHCounterpartyRequest","kind":"json-schema","title":"CreateACHCounterpartyRequest","data":{"properties":{"routing_number":{"type":"string","title":"Routing Number"},"account_number":{"type":"string","title":"Account Number"},"account_type":{"type":"string","enum":["CHECKING","SAVINGS"],"title":"Account Type","description":"Account type"},"counterparty_name":{"type":"string","title":"Counterparty Name"},"verification":{"oneOf":[{"$ref":"#/components/schemas/CreatePreVerifiedVerification"}],"title":"Verification","discriminator":{"propertyName":"type","mapping":{"pre_verified":"#/components/schemas/CreatePreVerifiedVerification"}}},"type":{"type":"string","const":"ach","title":"Type"},"display_name":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Display Name","description":"An optional custom display name for the counterparty, useful for distinguishing multiple counterparties that share the same legal name."},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional client-chosen UUID to assign as the counterparty's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Supply one to know the counterparty's ID before it is created — useful for correlating a create that goes through an approval flow, or for making a retry safe. Omit it and Jiko generates the ID. Reusing an ID that already exists is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"type":"object","required":["routing_number","account_number","account_type","counterparty_name","verification","type"],"title":"CreateACHCounterpartyRequest"}},"components/schemas/CreateCryptoDepositAddressPortalRequest":{"id":"components/schemas/CreateCryptoDepositAddressPortalRequest","kind":"json-schema","title":"CreateCryptoDepositAddressPortalRequest","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","maxLength":50,"title":"Name"},"chain":{"type":"string","title":"Chain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ETH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported at this time."},"children":[]}]}]}]},"type":{"type":"string","const":"CRYPTO_DEPOSIT_ADDRESS_PORTAL","title":"Type"}},"type":"object","required":["id","name","chain","type"],"title":"CreateCryptoDepositAddressPortalRequest"}},"components/schemas/CreateCryptoWalletAddressCounterpartyRequest":{"id":"components/schemas/CreateCryptoWalletAddressCounterpartyRequest","kind":"json-schema","title":"CreateCryptoWalletAddressCounterpartyRequest","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"chain":{"type":"string","title":"Chain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ETH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported at this time."},"children":[]}]}]}]},"wallet_address":{"type":"string","title":"Wallet Address"},"counterparty_name":{"type":"string","title":"Counterparty Name"},"type":{"type":"string","const":"crypto_wallet_address","title":"Type"}},"type":"object","required":["id","chain","wallet_address","counterparty_name","type"],"title":"CreateCryptoWalletAddressCounterpartyRequest"}},"components/schemas/CreateIncomingWireVerification":{"id":"components/schemas/CreateIncomingWireVerification","kind":"json-schema","title":"CreateIncomingWireVerification","data":{"properties":{"type":{"type":"string","const":"incoming_wire","title":"Type"},"wire_id":{"type":"string","format":"uuid","title":"Wire Id"}},"type":"object","required":["type","wire_id"],"title":"CreateIncomingWireVerification"}},"components/schemas/CreateIndividualIdentificationNumber":{"id":"components/schemas/CreateIndividualIdentificationNumber","kind":"json-schema","title":"CreateIndividualIdentificationNumber","data":{"properties":{"identification_number":{"type":"string","title":"Identification Number"},"issuing_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issuing Country","description":"A ISO-3166 Alpha-2 country code (Abbreviated. Example: \"US\")"},"identification_type":{"type":"string","enum":["SSN","PASSPORT","INTERNATIONAL_ID"],"title":"Identification Type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification provided in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identification_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. The options are"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SSN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Social security number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PASSPORT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A passport number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERNATIONAL_ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A government-issued national identity card. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERNATIONAL_ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type needs to be enabled. Please contact your Jiko representative. Selecting this value may prevent automatic onboarding and require manual review."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field will be made mandatory in a future release. Currently defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SSN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"type":"object","required":["identification_number","identification_type"],"title":"CreateIndividualIdentificationNumber"}},"components/schemas/CreateInternalReallocationTransfer":{"id":"components/schemas/CreateInternalReallocationTransfer","kind":"json-schema","title":"CreateInternalReallocationTransfer","data":{"properties":{"type":{"type":"string","const":"INTERNAL_REALLOCATION","title":"Type"},"destination_pocket_id":{"type":"string","format":"uuid","title":"Destination Pocket Id"},"transfer_type":{"anyOf":[{"type":"string","enum":["BANK_TRANSFER","SECURITY_TRANSFER"]},{"type":"null"}],"title":"Transfer Type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of internal reallocation transfer. BANK_TRANSFER (default): sells the CUSIP from the origin pocket and buys new CUSIP for the destination pocket. Settlement is T+1. SECURITY_TRANSFER: no bank transaction occurs; CUSIPs are moved directly between pockets. This is instant but only allowed for JikoNet pockets."},"children":[]}]}]}],"default":"BANK_TRANSFER"}},"type":"object","required":["type","destination_pocket_id"],"title":"CreateInternalReallocationTransfer"}},"components/schemas/CreateInternationalWireCounterpartyRequest":{"id":"components/schemas/CreateInternationalWireCounterpartyRequest","kind":"json-schema","title":"CreateInternationalWireCounterpartyRequest","data":{"properties":{"wire_instructions":{"anyOf":[{"type":"string","maxLength":140},{"type":"null"}],"title":"Wire Instructions","description":"Any additional wire instructions required for the wire to be processed correctly."},"counterparty_name":{"oneOf":[{"$ref":"#/components/schemas/IndividualName"},{"$ref":"#/components/schemas/BusinessName"}],"title":"Counterparty name","discriminator":{"propertyName":"type","mapping":{"business":"#/components/schemas/BusinessName","individual":"#/components/schemas/IndividualName"}}},"address":{"$ref":"#/components/schemas/CounterpartyAddress"},"identifier":{"type":"string","title":"Identifier","description":"Bank Account Number or IBAN Number"},"identifier_type":{"type":"string","enum":["iban","local"],"title":"Identifier Type","default":"local"},"swift_bic":{"type":"string","maxLength":11,"minLength":8,"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$","title":"Swift Bic","examples":["DEUTDEFF"]},"verification":{"oneOf":[{"$ref":"#/components/schemas/CreateSupportingDocumentsVerification"},{"$ref":"#/components/schemas/CreateUnverifiedVerification"}],"title":"Verification","discriminator":{"propertyName":"type","mapping":{"supporting_documents":"#/components/schemas/CreateSupportingDocumentsVerification","unverified":"#/components/schemas/CreateUnverifiedVerification"}}},"type":{"type":"string","const":"international_wire","title":"Type"},"ownership_type":{"anyOf":[{"type":"string","enum":["FIRST_PARTY","THIRD_PARTY"]},{"type":"null"}],"title":"Ownership Type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relationship of the counterparty to the account holder. FIRST_PARTY means the counterparty is owned by the account holder, THIRD_PARTY means it is owned by a different entity."},"children":[]}]}]}]},"display_name":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Display Name","description":"An optional custom display name for the counterparty, useful for distinguishing multiple counterparties that share the same legal name."},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional client-chosen UUID to assign as the counterparty's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Supply one to know the counterparty's ID before it is created — useful for correlating a create that goes through an approval flow, or for making a retry safe. Omit it and Jiko generates the ID. Reusing an ID that already exists is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"type":"object","required":["counterparty_name","address","identifier","swift_bic","verification","type"],"title":"CreateInternationalWireCounterpartyRequest"}},"components/schemas/CreateNameMatchVerification":{"id":"components/schemas/CreateNameMatchVerification","kind":"json-schema","title":"CreateNameMatchVerification","data":{"properties":{"type":{"type":"string","const":"name_match","title":"Type"},"legal_name":{"type":"string","title":"Legal Name"}},"type":"object","required":["type","legal_name"],"title":"CreateNameMatchVerification"}},"components/schemas/CreateOnUsCounterpartyRequest":{"id":"components/schemas/CreateOnUsCounterpartyRequest","kind":"json-schema","title":"CreateOnUsCounterpartyRequest","data":{"properties":{"account_number":{"type":"string","title":"Account Number","description":"Represents the Jiko network address of the pocket."},"verification":{"oneOf":[{"$ref":"#/components/schemas/CreateNameMatchVerification"}],"title":"Verification","discriminator":{"propertyName":"type","mapping":{"name_match":"#/components/schemas/CreateNameMatchVerification"}}},"type":{"type":"string","const":"on_us","title":"Type"},"display_name":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Display Name","description":"An optional custom display name for the counterparty, useful for distinguishing multiple counterparties that share the same legal name."},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional client-chosen UUID to assign as the counterparty's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Supply one to know the counterparty's ID before it is created — useful for correlating a create that goes through an approval flow, or for making a retry safe. Omit it and Jiko generates the ID. Reusing an ID that already exists is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"type":"object","required":["account_number","verification","type"],"title":"CreateOnUsCounterpartyRequest"}},"components/schemas/CreateOnUsTransfer":{"id":"components/schemas/CreateOnUsTransfer","kind":"json-schema","title":"CreateOnUsTransfer","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"type":{"type":"string","const":"ON_US","title":"Type"},"origin_pocket_id":{"type":"string","format":"uuid","title":"Origin Pocket Id"},"amount":{"$ref":"#/components/schemas/CreateRequestedAmount"},"details":{"anyOf":[{"$ref":"#/components/schemas/CreatePeerToPeerTransfer"},{"$ref":"#/components/schemas/CreateInternalReallocationTransfer"}],"title":"Details"},"description":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Description"},"end_to_end_identification":{"anyOf":[{"type":"string","maxLength":35},{"type":"null"}],"title":"End To End Identification"}},"type":"object","required":["id","type","origin_pocket_id","amount","details"],"title":"CreateOnUsTransfer"}},"components/schemas/CreatePeerToPeerTransfer":{"id":"components/schemas/CreatePeerToPeerTransfer","kind":"json-schema","title":"CreatePeerToPeerTransfer","data":{"properties":{"type":{"type":"string","const":"PEER_TO_PEER","title":"Type"},"destination_counterparty_id":{"type":"string","format":"uuid","title":"Destination Counterparty Id"}},"type":"object","required":["type","destination_counterparty_id"],"title":"CreatePeerToPeerTransfer"}},"components/schemas/CreatePocketConfigurationId":{"id":"components/schemas/CreatePocketConfigurationId","kind":"json-schema","title":"CreatePocketConfigurationId","data":{"type":"string","enum":["UST-52W","UST-26W","UST-13W","UST-4W","UST-1W"],"title":"CreatePocketConfigurationId"}},"components/schemas/CreatePocketRequest":{"id":"components/schemas/CreatePocketRequest","kind":"json-schema","title":"CreatePocketRequest","data":{"properties":{"pocket_name":{"type":"string","maxLength":100,"title":"Pocket Name","description":"Pocket name"},"deposit_strategy_id":{"$ref":"#/components/schemas/CreatePocketConfigurationId","description":"Pocket deposit trading strategy ID (Example: UST-4W)"},"reinvestment_strategy_id":{"anyOf":[{"$ref":"#/components/schemas/CreatePocketConfigurationId"},{"type":"null"}],"description":"Pocket reinvestment trading strategy ID (Example: UST-4W)"},"type":{"anyOf":[{"type":"string","enum":["JIKO_PAY","JIKO_STORE"]},{"type":"null"}],"title":"Type","description":"Pocket type"}},"type":"object","required":["pocket_name","deposit_strategy_id"],"title":"CreatePocketRequest"}},"components/schemas/CreatePreVerifiedVerification":{"id":"components/schemas/CreatePreVerifiedVerification","kind":"json-schema","title":"CreatePreVerifiedVerification","data":{"properties":{"type":{"type":"string","const":"pre_verified","title":"Type"},"verification_method":{"type":"string","enum":["PLAID","MICRO_DEPOSIT"],"title":"Verification Method","description":"Underlying verification method"}},"type":"object","required":["type","verification_method"],"title":"CreatePreVerifiedVerification"}},"components/schemas/CreateReportRequest":{"id":"components/schemas/CreateReportRequest","kind":"json-schema","title":"CreateReportRequest","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"report":{"oneOf":[{"$ref":"#/components/schemas/BankStatementReport"},{"$ref":"#/components/schemas/TradeReport"},{"$ref":"#/components/schemas/SecurityPriceReport"},{"$ref":"#/components/schemas/BrokerageStatementReport"},{"$ref":"#/components/schemas/PositionSummaryReport"}],"title":"Report","discriminator":{"propertyName":"type","mapping":{"BANK_STATEMENT_REPORT":"#/components/schemas/BankStatementReport","BROKERAGE_STATEMENT_REPORT":"#/components/schemas/BrokerageStatementReport","POSITION_SUMMARY_REPORT":"#/components/schemas/PositionSummaryReport","SECURITY_PRICE_REPORT":"#/components/schemas/SecurityPriceReport","TRADE_REPORT":"#/components/schemas/TradeReport"}}},"output_formats":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":20,"minItems":1},{"type":"null"}],"title":"Output Formats","description":"If specified, renders only the specified formats. If not specified, renders all the available formats for the given report. The available formats differ depending on the report being requested. For a description of what formats are available per report, please refer to the Create Report Request endpoint description."}},"type":"object","required":["id","report"],"title":"CreateReportRequest"}},"components/schemas/CreateRequestedAmount":{"id":"components/schemas/CreateRequestedAmount","kind":"json-schema","title":"CreateRequestedAmount","data":{"properties":{"type":{"type":"string","const":"REQUESTED_AMOUNT","title":"Type"},"amount_usdc":{"type":"integer","exclusiveMinimum":0,"title":"Amount Usdc"}},"type":"object","required":["type","amount_usdc"],"title":"CreateRequestedAmount"}},"components/schemas/CreateServiceUserRequest":{"id":"components/schemas/CreateServiceUserRequest","kind":"json-schema","title":"CreateServiceUserRequest","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"email":{"type":"string","format":"email","title":"Email"},"display_name":{"type":"string","title":"Display Name"},"role":{"$ref":"#/components/schemas/Role"},"authorization_request_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Authorization Request Id"}},"type":"object","required":["id","email","display_name","role"],"title":"CreateServiceUserRequest"}},"components/schemas/CreateSubscriptionRequest":{"id":"components/schemas/CreateSubscriptionRequest","kind":"json-schema","title":"CreateSubscriptionRequest","data":{"properties":{"description":{"type":"string","title":"Description","description":"A description of the webhook's intended use.","default":""},"events":{"items":{"type":"string"},"type":"array","minItems":1,"title":"Events","description":"Which types of events this webhook should be invoked for."},"url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Url","description":"The webhook URL to invoke."},"retry_policy":{"anyOf":[{"$ref":"#/components/schemas/RetryPolicy"},{"type":"null"}],"description":"The retry policy to use if Jiko encounters HTTP errors when calling subscription URLs."},"shared_secret":{"type":"string","minLength":16,"title":"Shared Secret","description":"The shared secret used by the Partner API to sign requests made to the webhook. The shared secret needs to be minimum 16 characters long."}},"type":"object","required":["events","url","shared_secret"],"title":"CreateSubscriptionRequest"}},"components/schemas/CreateSupportingDocumentsVerification":{"id":"components/schemas/CreateSupportingDocumentsVerification","kind":"json-schema","title":"CreateSupportingDocumentsVerification","data":{"properties":{"type":{"type":"string","const":"supporting_documents","title":"Type"},"document_ids":{"items":{"type":"string","format":"uuid"},"type":"array","minItems":1,"title":"Document Ids"}},"type":"object","required":["type","document_ids"],"title":"CreateSupportingDocumentsVerification"}},"components/schemas/CreateTransferRequest":{"id":"components/schemas/CreateTransferRequest","kind":"json-schema","title":"CreateTransferRequest","data":{"properties":{"transfer":{"oneOf":[{"$ref":"#/components/schemas/CreateWireTransfer"},{"$ref":"#/components/schemas/CreateOnUsTransfer"},{"$ref":"#/components/schemas/CreateUsdcTransfer"}],"title":"Transfer","discriminator":{"propertyName":"type","mapping":{"ON_US":"#/components/schemas/CreateOnUsTransfer","USDC":"#/components/schemas/CreateUsdcTransfer","WIRE":"#/components/schemas/CreateWireTransfer"}}},"reviewers":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Reviewers"},"notify_member_ids":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Notify Member Ids"}},"type":"object","required":["transfer"],"title":"CreateTransferRequest"}},"components/schemas/CreateUnverifiedVerification":{"id":"components/schemas/CreateUnverifiedVerification","kind":"json-schema","title":"CreateUnverifiedVerification","data":{"properties":{"type":{"type":"string","const":"unverified","title":"Type"}},"type":"object","required":["type"],"title":"CreateUnverifiedVerification"}},"components/schemas/CreateUsdcTransfer":{"id":"components/schemas/CreateUsdcTransfer","kind":"json-schema","title":"CreateUsdcTransfer","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"type":{"type":"string","const":"USDC","title":"Type"},"origin_pocket_id":{"type":"string","format":"uuid","title":"Origin Pocket Id"},"counterparty_id":{"type":"string","format":"uuid","title":"Counterparty Id"},"amount":{"$ref":"#/components/schemas/CreateRequestedAmount"}},"type":"object","required":["id","type","origin_pocket_id","counterparty_id","amount"],"title":"CreateUsdcTransfer"}},"components/schemas/CreateVirtualBankAccountPortalRequest":{"id":"components/schemas/CreateVirtualBankAccountPortalRequest","kind":"json-schema","title":"CreateVirtualBankAccountPortalRequest","data":{"properties":{"name":{"type":"string","maxLength":50,"title":"Name"},"type":{"type":"string","const":"VIRTUAL_BANK_ACCOUNT_PORTAL","title":"Type"}},"type":"object","required":["name","type"],"title":"CreateVirtualBankAccountPortalRequest"}},"components/schemas/CreateWireCounterpartyRequest":{"id":"components/schemas/CreateWireCounterpartyRequest","kind":"json-schema","title":"CreateWireCounterpartyRequest","data":{"properties":{"routing_number":{"type":"string","title":"Routing Number"},"identifier":{"type":"string","title":"Identifier","description":"Bank Account Number or IBAN Number"},"identifier_code":{"anyOf":[{"type":"string","enum":["SWIFT_BIC","CHIPS_PARTICIPANT","DIRECT_DEPOSIT_ACCOUNT","FED_ROUTING_NUMBER","SWIFT_ID_AND_ACCOUNT_NUMBER","CHIPS_IDENTIFIER","PASSPORT_NUMBER","TAX_IDENTIFICATION_NUMBER","DRIVERS_LICENSE_NUMBER","ALIEN_REGISTRATION_NUMBER","CORPORATE_IDENTIFICATION","OTHER_IDENTIFICATION"]},{"type":"null"}],"title":"Identifier Code","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[DEPRECATED] This field is ignored. The identifier code is always set to WireCounterpartyIdentifierCode_DDA_D (Demand Deposit Account)."},"children":[]}]}]}],"deprecated":true},"address":{"$ref":"#/components/schemas/CounterpartyAddress"},"wire_instructions":{"anyOf":[{"type":"string","maxLength":140},{"type":"null"}],"title":"Wire Instructions","description":"Any additional wire instructions required for the wire to be processed correctly."},"counterparty_name":{"oneOf":[{"$ref":"#/components/schemas/IndividualName"},{"$ref":"#/components/schemas/BusinessName"}],"title":"Counterparty name","discriminator":{"propertyName":"type","mapping":{"business":"#/components/schemas/BusinessName","individual":"#/components/schemas/IndividualName"}}},"verification":{"oneOf":[{"$ref":"#/components/schemas/CreateSupportingDocumentsVerification"},{"$ref":"#/components/schemas/CreateIncomingWireVerification"},{"$ref":"#/components/schemas/CreatePreVerifiedVerification"},{"$ref":"#/components/schemas/CreateUnverifiedVerification"}],"title":"Verification","discriminator":{"propertyName":"type","mapping":{"incoming_wire":"#/components/schemas/CreateIncomingWireVerification","pre_verified":"#/components/schemas/CreatePreVerifiedVerification","supporting_documents":"#/components/schemas/CreateSupportingDocumentsVerification","unverified":"#/components/schemas/CreateUnverifiedVerification"}}},"type":{"type":"string","const":"wire","title":"Type"},"ownership_type":{"anyOf":[{"type":"string","enum":["FIRST_PARTY","THIRD_PARTY"]},{"type":"null"}],"title":"Ownership Type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relationship of the counterparty to the account holder. FIRST_PARTY means the counterparty is owned by the account holder, THIRD_PARTY means it is owned by a different entity."},"children":[]}]}]}]},"display_name":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Display Name","description":"An optional custom display name for the counterparty, useful for distinguishing multiple counterparties that share the same legal name."},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional client-chosen UUID to assign as the counterparty's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Supply one to know the counterparty's ID before it is created — useful for correlating a create that goes through an approval flow, or for making a retry safe. Omit it and Jiko generates the ID. Reusing an ID that already exists is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"type":"object","required":["routing_number","identifier","address","counterparty_name","verification","type"],"title":"CreateWireCounterpartyRequest"}},"components/schemas/CreateWireTransfer":{"id":"components/schemas/CreateWireTransfer","kind":"json-schema","title":"CreateWireTransfer","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"type":{"type":"string","const":"WIRE","title":"Type"},"origin_pocket_id":{"type":"string","format":"uuid","title":"Origin Pocket Id"},"counterparty_id":{"type":"string","format":"uuid","title":"Counterparty Id"},"amount":{"$ref":"#/components/schemas/CreateRequestedAmount"},"description":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Description"}},"type":"object","required":["id","type","origin_pocket_id","counterparty_id","amount"],"title":"CreateWireTransfer"}},"components/schemas/CreditTransactionActivity":{"id":"components/schemas/CreditTransactionActivity","kind":"json-schema","title":"CreditTransactionActivity","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The ID of the transaction from the perspective of the respective pocket"},"transaction_id":{"type":"string","format":"uuid","title":"Transaction Id","description":"The ID of the transaction this activity is representing"},"description":{"type":"string","title":"Description","description":"A description of the transaction type, e.g. \"ACH Electronic Debit\"."},"amount":{"$ref":"#/components/schemas/Amount"},"time_booked":{"type":"string","format":"date-time","title":"Time Booked","description":"The time at which the transaction was originally booked into the ledger."},"time_settled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Time Settled","description":"The time at which transaction was settled."},"status":{"type":"string","enum":["BOOKED","SETTLED"],"title":"Status","description":"Status of the transactions. Has the transactions been settled"},"title":{"type":"string","title":"Title"},"direction":{"type":"string","enum":["DEBIT","CREDIT"],"title":"Direction"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":"The pocket associated with the transaction"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"The customer associated with the transaction"},"remittance_information":{"anyOf":[{"$ref":"#/components/schemas/RemittanceInformation"},{"type":"null"}]},"type":{"type":"string","const":"CREDIT","title":"Type"},"period":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period","description":"Set if cash back for a certain card period."},"card_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Card Id","description":"The ID of the card related to the credit."}},"type":"object","required":["id","transaction_id","description","amount","time_booked","time_settled","status","title","direction","pocket_id","customer_id","type"],"title":"CreditTransactionActivity"}},"components/schemas/CryptoDepositAddressPortal":{"id":"components/schemas/CryptoDepositAddressPortal","kind":"json-schema","title":"CryptoDepositAddressPortal","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id"},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"name":{"type":"string","title":"Name","description":"Portal name"},"status":{"type":"string","enum":["OPEN","CLOSED","PENDING","REJECTED"],"title":"Status","description":"Portal status"},"type":{"type":"string","const":"CRYPTO_DEPOSIT_ADDRESS_PORTAL","title":"Type"},"chain":{"type":"string","title":"Chain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ETH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported at this time."},"children":[]}]}]}]},"wallet_address":{"type":"string","title":"Wallet Address"}},"type":"object","required":["id","pocket_id","time_created","name","status","type","chain","wallet_address"],"title":"CryptoDepositAddressPortal"}},"components/schemas/CryptoWalletAddressCounterpartyV2":{"id":"components/schemas/CryptoWalletAddressCounterpartyV2","kind":"json-schema","title":"Crypto wallet address Counterparty","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"status":{"type":"string","enum":["PENDING","FAILED","LINKED","UNLINKED","CLOSED"],"title":"Status"},"verification":{"oneOf":[{"$ref":"#/components/schemas/SupportingDocumentsVerification"},{"$ref":"#/components/schemas/IncomingWireVerification"},{"$ref":"#/components/schemas/PreVerifiedVerification"},{"$ref":"#/components/schemas/PlaidVerification"},{"$ref":"#/components/schemas/MicroDepositsVerification"},{"$ref":"#/components/schemas/NameMatchVerification"},{"$ref":"#/components/schemas/UnverifiedVerification"}],"title":"Verification","discriminator":{"propertyName":"type","mapping":{"incoming_wire":"#/components/schemas/IncomingWireVerification","micro_deposits":"#/components/schemas/MicroDepositsVerification","name_match":"#/components/schemas/NameMatchVerification","plaid":"#/components/schemas/PlaidVerification","pre_verified":"#/components/schemas/PreVerifiedVerification","supporting_documents":"#/components/schemas/SupportingDocumentsVerification","unverified":"#/components/schemas/UnverifiedVerification"}}},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name","description":"An optional custom display name for the counterparty, useful for distinguishing multiple counterparties that share the same legal name."},"counterparty_name":{"type":"string","title":"Counterparty Name"},"type":{"type":"string","const":"crypto_wallet_address","title":"Type"},"wallet_address":{"type":"string","title":"Wallet Address"},"chain":{"type":"string","title":"Chain"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","time_created","status","verification","counterparty_name","type","wallet_address","chain","object_type"],"title":"Crypto wallet address Counterparty"}},"components/schemas/CurrencyLeg":{"id":"components/schemas/CurrencyLeg","kind":"json-schema","title":"CurrencyLeg","data":{"properties":{"currency":{"type":"string","title":"Currency","description":"Currency code (e.g. 'USD')"},"description":{"type":"string","title":"Description","description":"A description of the currency leg"},"tradable_id":{"type":"string","title":"Tradable Id","description":"Internal identifier for the currency instrument"},"quantity":{"type":"integer","title":"Quantity","description":"Number of currency units in this leg"},"transaction_total":{"$ref":"#/components/schemas/Amount","description":"Total transaction value for this currency leg, in USD cents"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["currency","description","tradable_id","quantity","transaction_total","object_type"],"title":"CurrencyLeg"}},"components/schemas/CursorListResponse_Annotated_Union_ACHTransactionActivity__WireTransactionActivity__CardTransactionActivity__OnUsTransactionActivity__FeeTransactionActivity__CreditTransactionActivity__GenericTransactionActivity__OnChainTransactionActivity___FieldInfo_annotation_NoneType__required_True__discriminator__type____":{"id":"components/schemas/CursorListResponse_Annotated_Union_ACHTransactionActivity__WireTransactionActivity__CardTransactionActivity__OnUsTransactionActivity__FeeTransactionActivity__CreditTransactionActivity__GenericTransactionActivity__OnChainTransactionActivity___FieldInfo_annotation_NoneType__required_True__discriminator__type____","kind":"json-schema","title":"CursorListResponse[Annotated[Union[ACHTransactionActivity, WireTransactionActivity, CardTransactionActivity, OnUsTransactionActivity, FeeTransactionActivity, CreditTransactionActivity, GenericTransactionActivity, OnChainTransactionActivity], FieldInfo(annotation=NoneType, required=True, discriminator='type')]]","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"oneOf":[{"$ref":"#/components/schemas/ACHTransactionActivity"},{"$ref":"#/components/schemas/WireTransactionActivity"},{"$ref":"#/components/schemas/CardTransactionActivity"},{"$ref":"#/components/schemas/OnUsTransactionActivity"},{"$ref":"#/components/schemas/FeeTransactionActivity"},{"$ref":"#/components/schemas/CreditTransactionActivity"},{"$ref":"#/components/schemas/GenericTransactionActivity"},{"$ref":"#/components/schemas/OnChainTransactionActivity"}],"discriminator":{"propertyName":"type","mapping":{"ACH":"#/components/schemas/ACHTransactionActivity","CARD":"#/components/schemas/CardTransactionActivity","CREDIT":"#/components/schemas/CreditTransactionActivity","FEE":"#/components/schemas/FeeTransactionActivity","GENERIC":"#/components/schemas/GenericTransactionActivity","ON_CHAIN":"#/components/schemas/OnChainTransactionActivity","ON_US":"#/components/schemas/OnUsTransactionActivity","WIRE":"#/components/schemas/WireTransactionActivity"}}},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"CursorListResponse[Annotated[Union[ACHTransactionActivity, WireTransactionActivity, CardTransactionActivity, OnUsTransactionActivity, FeeTransactionActivity, CreditTransactionActivity, GenericTransactionActivity, OnChainTransactionActivity], FieldInfo(annotation=NoneType, required=True, discriminator='type')]]"}},"components/schemas/CursorListResponse_Event_":{"id":"components/schemas/CursorListResponse_Event_","kind":"json-schema","title":"CursorListResponse[Event]","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"$ref":"#/components/schemas/Event"},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"CursorListResponse[Event]"}},"components/schemas/CursorListResponse_Subscription_":{"id":"components/schemas/CursorListResponse_Subscription_","kind":"json-schema","title":"CursorListResponse[Subscription]","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"$ref":"#/components/schemas/Subscription"},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"CursorListResponse[Subscription]"}},"components/schemas/CusipSecurity":{"id":"components/schemas/CusipSecurity","kind":"json-schema","title":"CusipSecurity","data":{"properties":{"cusip":{"type":"string","title":"Cusip","description":"CUSIP identifier of the security"},"description":{"type":"string","title":"Description","description":"A description of the security (e.g. '6 Month T Bill')"},"tradable_id":{"type":"string","title":"Tradable Id","description":"Internal identifier for the tradable instrument"},"maturity_date":{"type":"string","format":"date","title":"Maturity Date","description":"Maturity date of the fixed income instrument"},"quantity":{"type":"integer","title":"Quantity","description":"Number of securities in this leg"},"price":{"anyOf":[{"$ref":"#/components/schemas/Decimal"},{"type":"null"}],"description":"Unit price of the security at the time of the trade"},"transaction_total":{"$ref":"#/components/schemas/Amount","description":"Total transaction value for this security leg, in USD cents"},"original_purchase_price":{"anyOf":[{"$ref":"#/components/schemas/Decimal"},{"type":"null"}],"description":"Original purchase price from the source tax lot. Only populated for security transfer trades."},"original_settlement_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Original Settlement Date","description":"Original settlement date from the source tax lot. Only populated for security transfer trades."},"original_trade_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Original Trade Date","description":"Original trade date from the source tax lot. Only populated for security transfer trades."},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["cusip","description","tradable_id","maturity_date","quantity","transaction_total","object_type"],"title":"CusipSecurity"}},"components/schemas/Customer":{"id":"components/schemas/Customer","kind":"json-schema","title":"Customer","data":{"oneOf":[{"$ref":"#/components/schemas/Individual"},{"$ref":"#/components/schemas/Business"}],"title":"Customer","discriminator":{"propertyName":"type","mapping":{"BUSINESS":"#/components/schemas/Business","INDIVIDUAL":"#/components/schemas/Individual"}}}},"components/schemas/CustomerAuditLogEntry":{"id":"components/schemas/CustomerAuditLogEntry","kind":"json-schema","title":"CustomerAuditLogEntry","data":{"properties":{"actor":{"type":"string","title":"Actor"},"event_name":{"anyOf":[{"type":"string","enum":["account.list","account.get","pocket.get","pocket.list","pocket.create","pocket.modify","pocket_earnings.get","pocket_earnings.list","statement.list","portal.list","portal.get","portal.create","portal.modify","agreement.list","counterparty.list","trade.list","trade_confirmation.get","wire.list","wire.get","transaction.list","transaction.get","counterparty.get","counterparty.create","counterparty.update","team.audit-logs.get","transfer_request.approve","transfer_request.cancel","transfer_request.deny","transfer_request.create","transfer_request.get","transfer_request.list","transfer_request.on_us_quote","authorization_code.create","oauth_client.create","oauth_client.update","personal_access_token.create","sso_provider.create","sso_provider.authorize","sso_provider.update","sso_provider.set_enabled","sso_provider.delete","sso_provider.rotate_certs","user.authentication_failed","user.authenticate","user.initiate_reset_password","user.confirm_reset_password","user.grant_oauth_client","user.grant_sso","user.revoke_oauth_client","user.revoke_sso","user.logout","auth.backchannel_logout","token.create","token.revoke","authorization_code.get","id_token.get","team_member.cancel_invite","user.confirm_signup","team_member.deactivate","team_member.modify","user.modify","team_member.login","team_member.invite","user.onboard","team_member.reactivate","user.signup","team_member.get","team.get","document.upload","rfi.update","rfi.upload_document","rfi.detach_document","user.token_exchange","oauth_token.create","oauth_credentials.create","integration_grant.read","integration.enroll","integration.reauthorize","report_request.list","report_request.get","report_request.create","report.get","report.download","authorization_request.get","authorization_request.create","approval_rule.validate","approval_rule.get","approval_rule.list","service_user.create","authorization_request.revoke_approval","authorization_request.approve","authorization_request.deny","authorization_request.list","handoff_ticket.create"]},{"type":"string"}],"title":"Event Name"},"id":{"type":"string","format":"uuid","title":"Id"},"entry_metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Entry Metadata"},"team_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Team Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"}},"type":"object","required":["actor","event_name","id","timestamp"],"title":"CustomerAuditLogEntry"}},"components/schemas/CustomerAuditLogResults":{"id":"components/schemas/CustomerAuditLogResults","kind":"json-schema","title":"CustomerAuditLogResults","data":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CustomerAuditLogEntry"},"type":"array","title":"Items"},"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"}},"type":"object","required":["items"],"title":"CustomerAuditLogResults"}},"components/schemas/CustomerEarningsResponse":{"id":"components/schemas/CustomerEarningsResponse","kind":"json-schema","title":"CustomerEarningsResponse","data":{"properties":{"aggregate":{"anyOf":[{"$ref":"#/components/schemas/EarningsResponse"},{"type":"null"}]},"pockets":{"items":{"$ref":"#/components/schemas/PocketEarnings"},"type":"array","title":"Pockets"}},"type":"object","required":["aggregate","pockets"],"title":"CustomerEarningsResponse"}},"components/schemas/CustomerNotification":{"id":"components/schemas/CustomerNotification","kind":"json-schema","title":"CustomerNotification","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"description":{"type":"string","title":"Description"},"status":{"anyOf":[{"$ref":"#/components/schemas/NotificationStatus"},{"type":"null"}]},"title":{"type":"string","title":"Title"},"type":{"type":"string","title":"Type"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"notification_metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Notification Metadata"}},"type":"object","required":["id","description","status","title","type","created_at"],"title":"CustomerNotification"}},"components/schemas/CustomerNotificationsResult":{"id":"components/schemas/CustomerNotificationsResult","kind":"json-schema","title":"CustomerNotificationsResult","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"$ref":"#/components/schemas/CustomerNotification"},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"CustomerNotificationsResult"}},"components/schemas/CustomerPocket":{"id":"components/schemas/CustomerPocket","kind":"json-schema","title":"CustomerPocket","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"ID of the pocket"},"pocket_name":{"type":"string","title":"Pocket Name","description":"Pocket name"},"portfolio":{"anyOf":[{"$ref":"#/components/schemas/Portfolio"},{"type":"null"}],"description":"Total liquid cash and holdings"},"status":{"type":"string","enum":["PENDING","OPEN","FROZEN","CLOSED"],"title":"Status","description":"Pocket status"},"attributes":{"items":{"type":"string"},"type":"array","title":"Attributes"},"deposit_strategy_id":{"type":"string","title":"Deposit Strategy Id","description":"Pocket deposit trading strategy ID (Example: UST-4W)"},"reinvestment_strategy_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reinvestment Strategy Id","description":"Pocket reinvestment trading strategy ID (Example: UST-4W)"},"type":{"anyOf":[{"type":"string","enum":["JIKO_PAY","JIKO_STORE"]},{"type":"null"}],"title":"Type","description":"Pocket type"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"The ID of the customer this pocket belongs to"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","pocket_name","status","deposit_strategy_id","reinvestment_strategy_id","customer_id","object_type"],"title":"CustomerPocket"}},"components/schemas/Decimal":{"id":"components/schemas/Decimal","kind":"json-schema","title":"Decimal","data":{"type":"string","title":"Decimal"}},"components/schemas/DeliveryAttemptDetails":{"id":"components/schemas/DeliveryAttemptDetails","kind":"json-schema","title":"DeliveryAttemptDetails","data":{"properties":{"delivery_attempt_id":{"type":"string","format":"uuid","title":"Delivery Attempt Id"},"subscription_id":{"type":"string","format":"uuid","title":"Subscription Id"},"success":{"type":"boolean","title":"Success"},"response_code":{"type":"integer","title":"Response Code"},"response_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Message"},"called_at":{"type":"string","format":"date-time","title":"Called At"}},"type":"object","required":["delivery_attempt_id","subscription_id","success","response_code","response_message","called_at"],"title":"DeliveryAttemptDetails"}},"components/schemas/DenialReason":{"id":"components/schemas/DenialReason","kind":"json-schema","title":"DenialReason","data":{"type":"string","enum":["INCORRECT_AMOUNT","INCORRECT_PAYEE","OTHER"],"title":"DenialReason"}},"components/schemas/Document":{"id":"components/schemas/Document","kind":"json-schema","title":"Document","data":{"properties":{"id":{"type":"string","title":"Id"},"type":{"type":"string","enum":["ID_FRONT","ID_BACK","ID_BARCODE","SELFIE","IDENTIFICATION_NUMBER_VERIFICATION","ADDRESS_VERIFICATION","PASSPORT","EIN_CONFIRMATION","OPERATING_AGREEMENT","PARTNERSHIP_AGREEMENT","ARTICLES_OF_INCORPORATION","BYLAWS","PROOF_OF_501_STATUS","ARTICLES_OF_ASSOCIATION","CORPORATE_CHARTER","TRUST_FORMATION_RECORDS","LIST_OF_TRUSTEES","TRUST_VERIFICATION_DOCUMENT","LEGAL_ANALYSIS_OF_BUSINESS_MODEL","COINS_AND_TOKENS_LISTED_AND_OFFERED","COIN_RATING_POLICY_AND_PROCEDURES","TYPE_OF_BLOCKCHAIN_ANALYTICS_USED","MARKET_MANIPULATION_POLICY","BSA_AML_OFAC_POLICIES","INDEPENDENT_AML_AUDIT_REPORT","BSA_AML_OFAC_INTERNAL_RISK_ASSESSMENT","ARTICLES_OF_ORGANIZATION","FLOW_OF_FUNDS","BANK_STATEMENTS_1","BANK_STATEMENTS_2","BANK_STATEMENTS_3","ORG_CHART","BUSINESS_DESCRIPTION","CERTIFICATE_OF_GOOD_STANDING","CERTIFICATE_OF_TRADE_NAME","COMPANY_RESOLUTION","SIGNATURE_AUTHORIZATION","BANK_STATEMENT","BUSINESS_LICENSE","CERTIFICATE_OF_EXISTENCE","CERTIFICATE_OF_ASSUMED_NAME","COMPANY_REGISTRATION_DOCUMENT","INTERNAL_KYC_AUDIT","EXTERNAL_KYC_AUDIT","KYC_POLICIES_AND_PROCEDURES","WIRE_COUNTERPARTY_VERIFICATION","CUSTOMER_RFI_REPLY","OTHER"],"title":"Type"},"status":{"type":"string","enum":["PENDING_UPLOAD","PENDING_REVIEW","APPROVED","INVALID"],"title":"Status"},"exception_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exception Reason"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","required":["id","type","status"],"title":"Document"}},"components/schemas/DomesticWireFundingInstruction":{"id":"components/schemas/DomesticWireFundingInstruction","kind":"json-schema","title":"DomesticWireFundingInstruction","data":{"properties":{"type":{"type":"string","const":"DOMESTIC_WIRE","title":"Type"},"receiver_bank":{"$ref":"#/components/schemas/ReceiverBank"},"beneficiary":{"$ref":"#/components/schemas/Beneficiary"}},"type":"object","required":["type","receiver_bank","beneficiary"],"title":"DomesticWireFundingInstruction"}},"components/schemas/DualAuthUser":{"id":"components/schemas/DualAuthUser","kind":"json-schema","title":"DualAuthUser","data":{"properties":{"user_id":{"type":"string","format":"uuid","title":"User Id"},"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"},"active":{"type":"boolean","title":"Active"},"role":{"$ref":"#/components/schemas/MakerChecker"}},"type":"object","required":["user_id","first_name","last_name","active","role"],"title":"DualAuthUser"}},"components/schemas/EarningsResponse":{"id":"components/schemas/EarningsResponse","kind":"json-schema","title":"EarningsResponse","data":{"properties":{"earnings":{"$ref":"#/components/schemas/Amount"},"date_from":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"},"date_to":{"type":"string","format":"date","title":"Date To"},"pricing_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Pricing Timestamp"},"appreciation_per_second":{"anyOf":[{"$ref":"#/components/schemas/Decimal"},{"type":"null"}]}},"type":"object","required":["earnings","date_from","date_to"],"title":"EarningsResponse"}},"components/schemas/EditTeamMemberRequest":{"id":"components/schemas/EditTeamMemberRequest","kind":"json-schema","title":"EditTeamMemberRequest","data":{"properties":{"role":{"anyOf":[{"$ref":"#/components/schemas/Role"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","const":"ACTIVE"},{"type":"null"}],"title":"Status"}},"type":"object","title":"EditTeamMemberRequest"}},"components/schemas/Event":{"id":"components/schemas/Event","kind":"json-schema","title":"Event","data":{"properties":{"event":{"$ref":"#/components/schemas/EventDetails"},"delivery_attempts":{"items":{"$ref":"#/components/schemas/DeliveryAttemptDetails"},"type":"array","title":"Delivery Attempts"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["event","delivery_attempts","object_type"],"title":"Event"}},"components/schemas/EventDetails":{"id":"components/schemas/EventDetails","kind":"json-schema","title":"EventDetails","data":{"oneOf":[{"$ref":"#/components/schemas/OutgoingWireEvent"},{"$ref":"#/components/schemas/OnUsTransferEvent"},{"$ref":"#/components/schemas/TransferRequestEvent"},{"$ref":"#/components/schemas/IncomingWireEvent"},{"$ref":"#/components/schemas/OnUsTransferReceivedEvent"}],"title":"EventDetails","discriminator":{"propertyName":"event_type","mapping":{"transfer-request.status.approved":"#/components/schemas/TransferRequestEvent","transfer-request.status.canceled":"#/components/schemas/TransferRequestEvent","transfer-request.status.denied":"#/components/schemas/TransferRequestEvent","transfer-request.status.processed":"#/components/schemas/TransferRequestEvent","transfer-request.status.processing":"#/components/schemas/TransferRequestEvent","transfer-request.status.rejected":"#/components/schemas/TransferRequestEvent","transfers.on-us.processing":"#/components/schemas/OnUsTransferEvent","transfers.on-us.received":"#/components/schemas/OnUsTransferReceivedEvent","transfers.on-us.rejected":"#/components/schemas/OnUsTransferEvent","transfers.on-us.success":"#/components/schemas/OnUsTransferEvent","transfers.wire.in.rejected":"#/components/schemas/IncomingWireEvent","transfers.wire.in.success":"#/components/schemas/IncomingWireEvent","transfers.wire.out.processing":"#/components/schemas/OutgoingWireEvent","transfers.wire.out.rejected":"#/components/schemas/OutgoingWireEvent","transfers.wire.out.success":"#/components/schemas/OutgoingWireEvent"}}}},"components/schemas/FeeTransactionActivity":{"id":"components/schemas/FeeTransactionActivity","kind":"json-schema","title":"FeeTransactionActivity","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The ID of the transaction from the perspective of the respective pocket"},"transaction_id":{"type":"string","format":"uuid","title":"Transaction Id","description":"The ID of the transaction this activity is representing"},"description":{"type":"string","title":"Description","description":"A description of the transaction type, e.g. \"ACH Electronic Debit\"."},"amount":{"$ref":"#/components/schemas/Amount"},"time_booked":{"type":"string","format":"date-time","title":"Time Booked","description":"The time at which the transaction was originally booked into the ledger."},"time_settled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Time Settled","description":"The time at which transaction was settled."},"status":{"type":"string","enum":["BOOKED","SETTLED"],"title":"Status","description":"Status of the transactions. Has the transactions been settled"},"title":{"type":"string","title":"Title"},"direction":{"type":"string","enum":["DEBIT","CREDIT"],"title":"Direction"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":"The pocket associated with the transaction"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"The customer associated with the transaction"},"remittance_information":{"anyOf":[{"$ref":"#/components/schemas/RemittanceInformation"},{"type":"null"}]},"type":{"type":"string","const":"FEE","title":"Type"},"fee_type":{"type":"string","title":"Fee Type"}},"type":"object","required":["id","transaction_id","description","amount","time_booked","time_settled","status","title","direction","pocket_id","customer_id","type","fee_type"],"title":"FeeTransactionActivity"}},"components/schemas/FixedIncomeSecurity":{"id":"components/schemas/FixedIncomeSecurity","kind":"json-schema","title":"FixedIncomeSecurity","data":{"properties":{"quantity":{"type":"integer","title":"Quantity","description":"Number of securities"},"market_value":{"$ref":"#/components/schemas/Amount","description":"The current market value of the securities"},"cusip":{"type":"string","title":"Cusip","description":"CUSIP number of security"},"jiko_mark_price":{"$ref":"#/components/schemas/Decimal","description":"Current price of security"},"description":{"type":"string","title":"Description","description":"A description of the security"},"type":{"type":"string","const":"FIXED_INCOME","title":"Type"},"maturity_date":{"type":"string","format":"date","title":"Maturity Date","description":"Due date of the fixed income instrument"},"yield_to_maturity":{"$ref":"#/components/schemas/Decimal","description":"Rate of return if the security is held to the maturity date"}},"type":"object","required":["quantity","market_value","cusip","jiko_mark_price","description","type","maturity_date","yield_to_maturity"],"title":"FixedIncomeSecurity"}},"components/schemas/FullWithdrawal":{"id":"components/schemas/FullWithdrawal","kind":"json-schema","title":"FullWithdrawal","data":{"properties":{"type":{"type":"string","const":"FULL_WITHDRAWAL","title":"Type"}},"type":"object","required":["type"],"title":"FullWithdrawal"}},"components/schemas/FundingInstructionsResponse":{"id":"components/schemas/FundingInstructionsResponse","kind":"json-schema","title":"FundingInstructionsResponse","data":{"properties":{"items":{"items":{"oneOf":[{"$ref":"#/components/schemas/ACHFundingInstruction"},{"$ref":"#/components/schemas/DomesticWireFundingInstruction"},{"$ref":"#/components/schemas/InternationalWireFundingInstruction"},{"$ref":"#/components/schemas/OnUsFundingInstruction"},{"$ref":"#/components/schemas/USDCFundingInstruction"}],"discriminator":{"propertyName":"type","mapping":{"ACH":"#/components/schemas/ACHFundingInstruction","DOMESTIC_WIRE":"#/components/schemas/DomesticWireFundingInstruction","INTERNATIONAL_WIRE":"#/components/schemas/InternationalWireFundingInstruction","ON_US":"#/components/schemas/OnUsFundingInstruction","USDC":"#/components/schemas/USDCFundingInstruction"}}},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"FundingInstructionsResponse"}},"components/schemas/GeneralAddress":{"id":"components/schemas/GeneralAddress","kind":"json-schema","title":"GeneralAddress","data":{"properties":{"street_address":{"type":"string","maxLength":250,"title":"Street Address","description":"Street address"},"street_address2":{"anyOf":[{"type":"string","maxLength":250},{"type":"null"}],"title":"Street Address2","description":"Apartment, Suite, Box number, etc."},"city":{"type":"string","maxLength":250,"title":"City","description":"City / Town"},"postal_code":{"type":"string","maxLength":50,"title":"Postal Code","description":"Postal code / ZIP code"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State (Postal Abbreviations. Example: \"AL\", \"NJ\", \"OH\")"},"country":{"type":"string","title":"Country","description":"A ISO-3166 Alpha-2 country code (Abbreviated. Example: \"US\")"}},"type":"object","required":["street_address","city","postal_code","country"],"title":"GeneralAddress"}},"components/schemas/GenericTransactionActivity":{"id":"components/schemas/GenericTransactionActivity","kind":"json-schema","title":"GenericTransactionActivity","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The ID of the transaction from the perspective of the respective pocket"},"transaction_id":{"type":"string","format":"uuid","title":"Transaction Id","description":"The ID of the transaction this activity is representing"},"description":{"type":"string","title":"Description","description":"A description of the transaction type, e.g. \"ACH Electronic Debit\"."},"amount":{"$ref":"#/components/schemas/Amount"},"time_booked":{"type":"string","format":"date-time","title":"Time Booked","description":"The time at which the transaction was originally booked into the ledger."},"time_settled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Time Settled","description":"The time at which transaction was settled."},"status":{"type":"string","enum":["BOOKED","SETTLED"],"title":"Status","description":"Status of the transactions. Has the transactions been settled"},"title":{"type":"string","title":"Title"},"direction":{"type":"string","enum":["DEBIT","CREDIT"],"title":"Direction"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":"The pocket associated with the transaction"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"The customer associated with the transaction"},"remittance_information":{"anyOf":[{"$ref":"#/components/schemas/RemittanceInformation"},{"type":"null"}]},"type":{"type":"string","const":"GENERIC","title":"Type"},"reference_transaction_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Reference Transaction Id","description":"For reverse postings, the identity of the transaction being reversed. "}},"type":"object","required":["id","transaction_id","description","amount","time_booked","time_settled","status","title","direction","pocket_id","customer_id","type","reference_transaction_id"],"title":"GenericTransactionActivity"}},"components/schemas/HTTPValidationError":{"id":"components/schemas/HTTPValidationError","kind":"json-schema","title":"HTTPValidationError","data":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}},"components/schemas/ISOAddress":{"id":"components/schemas/ISOAddress","kind":"json-schema","title":"ISOAddress","data":{"properties":{"street_address":{"type":"string","maxLength":250,"title":"Street Address","description":"Street address"},"street_address2":{"anyOf":[{"type":"string","maxLength":250},{"type":"null"}],"title":"Street Address2","description":"Apartment, Suite, Box number, etc."},"city":{"type":"string","maxLength":250,"title":"City","description":"City / Town"},"postal_code":{"type":"string","maxLength":50,"title":"Postal Code","description":"Postal code / ZIP code"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State (Postal Abbreviations. Example: \"AL\", \"NJ\", \"OH\")"},"country":{"type":"string","title":"Country","description":"A ISO-3166 Alpha-2 country code (Abbreviated. Example: \"US\")"}},"type":"object","required":["street_address","city","postal_code","country"],"title":"ISOAddress"}},"components/schemas/ISOAddressRequest":{"id":"components/schemas/ISOAddressRequest","kind":"json-schema","title":"ISOAddressRequest","data":{"properties":{"street_address":{"type":"string","maxLength":250,"title":"Street Address","description":"Street address"},"street_address2":{"anyOf":[{"type":"string","maxLength":250},{"type":"null"}],"title":"Street Address2","description":"Apartment, Suite, Box number, etc."},"city":{"type":"string","maxLength":250,"title":"City","description":"City / Town"},"postal_code":{"type":"string","maxLength":50,"title":"Postal Code","description":"Postal code / ZIP code"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State (Postal Abbreviations. Example: \"AL\", \"NJ\", \"OH\")"},"country":{"type":"string","title":"Country","description":"A ISO-3166 Alpha-2 country code (Abbreviated. Example: \"US\")"}},"type":"object","required":["street_address","city","postal_code","country"],"title":"ISOAddressRequest"}},"components/schemas/IncomingWireEvent":{"id":"components/schemas/IncomingWireEvent","kind":"json-schema","title":"IncomingWireEvent","data":{"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/WireIncomingPayload"},"event_type":{"type":"string","enum":["transfers.wire.in.success","transfers.wire.in.rejected"],"title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"IncomingWireEvent"}},"components/schemas/IncomingWireResponse":{"id":"components/schemas/IncomingWireResponse","kind":"json-schema","title":"IncomingWireResponse","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"status":{"type":"string","enum":["PENDING","SUCCESS","REJECTED"],"title":"Status","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the wire transfer: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"amount":{"$ref":"#/components/schemas/Amount"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also known as jiko_account_id"},"children":[]}]}]}]},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"direction":{"type":"string","const":"INCOMING","title":"Direction","default":"INCOMING"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","status","amount","pocket_id","time_created","object_type"],"title":"IncomingWireResponse"}},"components/schemas/IncomingWireVerification":{"id":"components/schemas/IncomingWireVerification","kind":"json-schema","title":"IncomingWireVerification","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"type":{"type":"string","const":"incoming_wire","title":"Type"},"wire_id":{"type":"string","format":"uuid","title":"Wire Id"},"status":{"type":"string","enum":["PENDING_REVIEW","APPROVED","REJECTED"],"title":"Status"}},"type":"object","required":["id","description","type","wire_id","status"],"title":"IncomingWireVerification"}},"components/schemas/Individual":{"id":"components/schemas/Individual","kind":"json-schema","title":"Individual","data":{"properties":{"address":{"$ref":"#/components/schemas/GeneralAddress"},"email":{"type":"string","title":"Email"},"phone_number":{"type":"string","title":"Phone Number"},"account_status":{"type":"string","enum":["OPEN","CLOSED","FROZEN","PENDING"],"title":"Account Status"},"type":{"type":"string","const":"INDIVIDUAL","title":"Type"},"name":{"$ref":"#/components/schemas/Name"},"date_of_birth":{"type":"string","format":"date","title":"Date Of Birth"},"identification_number":{"$ref":"#/components/schemas/IndividualIdentificationNumberMasked"},"trusted_contact":{"anyOf":[{"$ref":"#/components/schemas/TrustedContact"},{"type":"null"}]}},"type":"object","required":["address","email","phone_number","account_status","type","name","date_of_birth","identification_number"],"title":"Individual"}},"components/schemas/IndividualIdentificationNumberMasked":{"id":"components/schemas/IndividualIdentificationNumberMasked","kind":"json-schema","title":"IndividualIdentificationNumberMasked","data":{"properties":{"identification_number":{"type":"string","title":"Identification Number"},"issuing_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issuing Country","description":"A ISO-3166 Alpha-2 country code (Abbreviated. Example: \"US\")"},"identification_type":{"type":"string","enum":["SSN","PASSPORT","INTERNATIONAL_ID","DRIVERS_LICENSE"],"title":"Identification Type"}},"type":"object","required":["identification_number","identification_type"],"title":"IndividualIdentificationNumberMasked"}},"components/schemas/IndividualName":{"id":"components/schemas/IndividualName","kind":"json-schema","title":"Individual name","data":{"properties":{"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"},"type":{"type":"string","const":"individual","title":"Type"}},"type":"object","required":["first_name","last_name","type"],"title":"Individual name"}},"components/schemas/IndustryInfo":{"id":"components/schemas/IndustryInfo","kind":"json-schema","title":"IndustryInfo","data":{"properties":{"industry":{"anyOf":[{"type":"string","enum":["ACCOUNTING_AND_BOOKKEEPING","ADVERTISING","ART","ATM_OPERATOR","BEAUTY_AND_COSMETIC_SERVICES","BIOTECH","BUSINESS_MANAGEMENT","CLEANING_SERVICES","CONSTRUCTION","CONSULTING","CRYPTOCURRENCY","DESIGN","ECOMMERCE","EDUCATION","ENERGY","ENTERTAINMENT","FINANCIAL_SERVICES","FITNESS","FOOD","GAMBLING","HARDWARE","HEALTHCARE","HOSPITALITY","INSURANCE","INVESTMENTS","LEGAL_SERVICES","MARKETING","MARKETPLACE","NONPROFIT","OTHER","PARKING_GARAGE","PROFESSIONAL_TECHNICAL_OR_MECHANICAL_SERVICES","REAL_ESTATE","RECRUITING","RESEARCH","RESTAURANT","RETAIL_STORES","SECURITY","SHIPPING_WAREHOUSING","SOFTWARE","SPORTS_TEAM","SUPPORT_SERVICES","TECHNOLOGY","TRANSPORTATION","TRAVEL","WHOLESALE","VENDING_MACHINE_OPERATOR","WASTE_MANAGEMENT"]},{"type":"null"}],"title":"Industry"},"other_industry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Other Industry"}},"type":"object","title":"IndustryInfo"}},"components/schemas/InternationalWireCounterpartyV2":{"id":"components/schemas/InternationalWireCounterpartyV2","kind":"json-schema","title":"International Wire Counterparty","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"status":{"type":"string","enum":["PENDING","FAILED","LINKED","UNLINKED","CLOSED"],"title":"Status"},"verification":{"oneOf":[{"$ref":"#/components/schemas/SupportingDocumentsVerification"},{"$ref":"#/components/schemas/IncomingWireVerification"},{"$ref":"#/components/schemas/PreVerifiedVerification"},{"$ref":"#/components/schemas/PlaidVerification"},{"$ref":"#/components/schemas/MicroDepositsVerification"},{"$ref":"#/components/schemas/NameMatchVerification"},{"$ref":"#/components/schemas/UnverifiedVerification"}],"title":"Verification","discriminator":{"propertyName":"type","mapping":{"incoming_wire":"#/components/schemas/IncomingWireVerification","micro_deposits":"#/components/schemas/MicroDepositsVerification","name_match":"#/components/schemas/NameMatchVerification","plaid":"#/components/schemas/PlaidVerification","pre_verified":"#/components/schemas/PreVerifiedVerification","supporting_documents":"#/components/schemas/SupportingDocumentsVerification","unverified":"#/components/schemas/UnverifiedVerification"}}},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name","description":"An optional custom display name for the counterparty, useful for distinguishing multiple counterparties that share the same legal name."},"type":{"type":"string","const":"international_wire","title":"Type"},"counterparty_name":{"oneOf":[{"$ref":"#/components/schemas/IndividualName"},{"$ref":"#/components/schemas/BusinessName"}],"title":"Counterparty name","discriminator":{"propertyName":"type","mapping":{"business":"#/components/schemas/BusinessName","individual":"#/components/schemas/IndividualName"}}},"address":{"$ref":"#/components/schemas/CounterpartyAddress"},"swift_bic":{"type":"string","title":"Swift Bic"},"identifier":{"type":"string","title":"Identifier"},"identifier_type":{"type":"string","enum":["iban","local"],"title":"Identifier Type","default":"local"},"bank_name":{"type":"string","title":"Bank Name"},"wire_instructions":{"anyOf":[{"type":"string","maxLength":140},{"type":"null"}],"title":"Wire Instructions","description":"Any additional wire instructions required for the wire to be processed correctly."},"ownership_type":{"anyOf":[{"type":"string","enum":["FIRST_PARTY","THIRD_PARTY"]},{"type":"null"}],"title":"Ownership Type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relationship of the counterparty to the account holder. FIRST_PARTY means the counterparty is owned by the account holder, THIRD_PARTY means it is owned by a different entity."},"children":[]}]}]}]},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","time_created","status","verification","type","counterparty_name","address","swift_bic","identifier","bank_name","object_type"],"title":"International Wire Counterparty"}},"components/schemas/InternationalWireFundingInstruction":{"id":"components/schemas/InternationalWireFundingInstruction","kind":"json-schema","title":"InternationalWireFundingInstruction","data":{"properties":{"type":{"type":"string","const":"INTERNATIONAL_WIRE","title":"Type"},"receiver_bank":{"$ref":"#/components/schemas/ReceiverBank"},"beneficiary":{"$ref":"#/components/schemas/Beneficiary"},"remittance_info":{"$ref":"#/components/schemas/RemittanceInfo"}},"type":"object","required":["type","receiver_bank","beneficiary","remittance_info"],"title":"InternationalWireFundingInstruction"}},"components/schemas/InviteMemberPayload":{"id":"components/schemas/InviteMemberPayload","kind":"json-schema","title":"InviteMemberPayload","data":{"properties":{"email":{"type":"string","title":"Email"},"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"},"phone_number":{"type":"string","title":"Phone Number"},"role":{"$ref":"#/components/schemas/Role"},"suppress_messages":{"type":"boolean","title":"Suppress Messages","default":false}},"type":"object","required":["email","first_name","last_name","phone_number","role"],"title":"InviteMemberPayload"}},"components/schemas/InviteMemberRequest":{"id":"components/schemas/InviteMemberRequest","kind":"json-schema","title":"InviteMemberRequest","data":{"properties":{"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"},"email":{"type":"string","format":"email","title":"Email"},"phone_number":{"type":"string","title":"Phone Number"},"role":{"$ref":"#/components/schemas/Role"},"authorization_request_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Authorization Request Id"},"invite_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Invite Id"}},"type":"object","required":["first_name","last_name","email","phone_number","role"],"title":"InviteMemberRequest"}},"components/schemas/ListBeneficialOwnersResponse":{"id":"components/schemas/ListBeneficialOwnersResponse","kind":"json-schema","title":"ListBeneficialOwnersResponse","data":{"properties":{"items":{"items":{"$ref":"#/components/schemas/BusinessIndividual","description":"a list of beneficial owners for a given customer"},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"ListBeneficialOwnersResponse"}},"components/schemas/ListPortalsResponse":{"id":"components/schemas/ListPortalsResponse","kind":"json-schema","title":"ListPortalsResponse","data":{"properties":{"count":{"type":"integer","title":"Count"},"portals":{"items":{"$ref":"#/components/schemas/Portal"},"type":"array","minItems":0,"title":"Portals"},"object_type":{"type":"string","title":"Object Type","default":"List"}},"type":"object","required":["count","portals"],"title":"ListPortalsResponse"}},"components/schemas/MakerChecker":{"id":"components/schemas/MakerChecker","kind":"json-schema","title":"MakerChecker","data":{"type":"string","enum":["MAKER","CHECKER","VIEWER"],"title":"MakerChecker"}},"components/schemas/MemberGroup":{"id":"components/schemas/MemberGroup","kind":"json-schema","title":"MemberGroup","data":{"properties":{"name":{"type":"string","title":"Name"},"total":{"type":"integer","title":"Total"},"members":{"items":{"$ref":"#/components/schemas/TeamMember"},"type":"array","title":"Members"}},"type":"object","required":["name","total","members"],"title":"MemberGroup"}},"components/schemas/MembershipInfo":{"id":"components/schemas/MembershipInfo","kind":"json-schema","title":"MembershipInfo","data":{"properties":{"team_id":{"type":"string","format":"uuid","title":"Team Id"},"member_id":{"type":"string","format":"uuid","title":"Member Id"},"customer_name":{"type":"string","title":"Customer Name"},"is_current":{"type":"boolean","title":"Is Current"},"last_login":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Login"},"role":{"$ref":"#/components/schemas/Role"},"partner_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Partner Id"}},"type":"object","required":["team_id","member_id","customer_name","is_current","role"],"title":"MembershipInfo"}},"components/schemas/MembershipStatus":{"id":"components/schemas/MembershipStatus","kind":"json-schema","title":"MembershipStatus","data":{"type":"string","enum":["PENDING","ACTIVE","DEACTIVATED"],"title":"MembershipStatus"}},"components/schemas/MicroDepositsVerification":{"id":"components/schemas/MicroDepositsVerification","kind":"json-schema","title":"MicroDepositsVerification","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"type":{"type":"string","const":"micro_deposits","title":"Type"},"status":{"anyOf":[{"type":"string","enum":["PENDING_REVIEW","APPROVED","REJECTED"]},{"type":"string","enum":["MICRO_DEPOSITS_SENT"]}],"title":"Status"},"verification_failure_count":{"type":"integer","title":"Verification Failure Count"}},"type":"object","required":["id","description","type","status","verification_failure_count"],"title":"MicroDepositsVerification"}},"components/schemas/Name":{"id":"components/schemas/Name","kind":"json-schema","title":"Name","data":{"properties":{"first_name":{"type":"string","maxLength":50,"title":"First Name","description":"First Name"},"middle_name":{"anyOf":[{"type":"string","maxLength":50},{"type":"null"}],"title":"Middle Name","description":"Middle Name"},"last_name":{"type":"string","maxLength":50,"title":"Last Name","description":"Last Name"}},"type":"object","required":["first_name","last_name"],"title":"Name"}},"components/schemas/NameMatchVerification":{"id":"components/schemas/NameMatchVerification","kind":"json-schema","title":"NameMatchVerification","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"type":{"type":"string","const":"name_match","title":"Type"}},"type":"object","required":["id","description","type"],"title":"NameMatchVerification"}},"components/schemas/NotificationStatus":{"id":"components/schemas/NotificationStatus","kind":"json-schema","title":"NotificationStatus","data":{"type":"string","enum":["READ","UNREAD"],"title":"NotificationStatus"}},"components/schemas/OnChainTransactionActivity":{"id":"components/schemas/OnChainTransactionActivity","kind":"json-schema","title":"OnChainTransactionActivity","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The ID of the transaction from the perspective of the respective pocket"},"transaction_id":{"type":"string","format":"uuid","title":"Transaction Id","description":"The ID of the transaction this activity is representing"},"description":{"type":"string","title":"Description","description":"A description of the transaction type, e.g. \"ACH Electronic Debit\"."},"amount":{"$ref":"#/components/schemas/Amount"},"time_booked":{"type":"string","format":"date-time","title":"Time Booked","description":"The time at which the transaction was originally booked into the ledger."},"time_settled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Time Settled","description":"The time at which transaction was settled."},"status":{"type":"string","enum":["BOOKED","SETTLED"],"title":"Status","description":"Status of the transactions. Has the transactions been settled"},"title":{"type":"string","title":"Title"},"direction":{"type":"string","enum":["DEBIT","CREDIT"],"title":"Direction"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":"The pocket associated with the transaction"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"The customer associated with the transaction"},"remittance_information":{"anyOf":[{"$ref":"#/components/schemas/RemittanceInformation"},{"type":"null"}]},"type":{"type":"string","const":"ON_CHAIN","title":"Type"},"blockchain_network":{"type":"string","title":"Blockchain Network"},"counterparty_wallet_address":{"type":"string","title":"Counterparty Wallet Address"},"counterparty_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty Name"},"end_to_end_identification":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End To End Identification"},"transaction_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Hash"}},"type":"object","required":["id","transaction_id","description","amount","time_booked","time_settled","status","title","direction","pocket_id","customer_id","type","blockchain_network","counterparty_wallet_address"],"title":"OnChainTransactionActivity"}},"components/schemas/OnUsCounterpartyV2":{"id":"components/schemas/OnUsCounterpartyV2","kind":"json-schema","title":"ON_US Counterparty","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"status":{"type":"string","enum":["PENDING","FAILED","LINKED","UNLINKED","CLOSED"],"title":"Status"},"verification":{"oneOf":[{"$ref":"#/components/schemas/SupportingDocumentsVerification"},{"$ref":"#/components/schemas/IncomingWireVerification"},{"$ref":"#/components/schemas/PreVerifiedVerification"},{"$ref":"#/components/schemas/PlaidVerification"},{"$ref":"#/components/schemas/MicroDepositsVerification"},{"$ref":"#/components/schemas/NameMatchVerification"},{"$ref":"#/components/schemas/UnverifiedVerification"}],"title":"Verification","discriminator":{"propertyName":"type","mapping":{"incoming_wire":"#/components/schemas/IncomingWireVerification","micro_deposits":"#/components/schemas/MicroDepositsVerification","name_match":"#/components/schemas/NameMatchVerification","plaid":"#/components/schemas/PlaidVerification","pre_verified":"#/components/schemas/PreVerifiedVerification","supporting_documents":"#/components/schemas/SupportingDocumentsVerification","unverified":"#/components/schemas/UnverifiedVerification"}}},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name","description":"An optional custom display name for the counterparty, useful for distinguishing multiple counterparties that share the same legal name."},"type":{"type":"string","const":"on_us","title":"Type"},"counterparty_name":{"type":"string","title":"Counterparty Name"},"account_number":{"type":"string","title":"Account Number","description":"Represents the Jiko network address of the pocket."},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","time_created","status","verification","type","counterparty_name","account_number","object_type"],"title":"ON_US Counterparty"}},"components/schemas/OnUsFundingInstruction":{"id":"components/schemas/OnUsFundingInstruction","kind":"json-schema","title":"OnUsFundingInstruction","data":{"properties":{"type":{"type":"string","const":"ON_US","title":"Type"},"account_number":{"type":"string","title":"Account Number","description":"Jiko network address of the portal"},"legal_name":{"type":"string","title":"Legal Name","description":"Customer legal name for counterparty creation"}},"type":"object","required":["type","account_number","legal_name"],"title":"OnUsFundingInstruction"}},"components/schemas/OnUsInternalReallocationTransferDetails":{"id":"components/schemas/OnUsInternalReallocationTransferDetails","kind":"json-schema","title":"OnUsInternalReallocationTransferDetails","data":{"properties":{"type":{"type":"string","const":"INTERNAL_REALLOCATION","title":"Type"},"destination_pocket_id":{"type":"string","format":"uuid","title":"Destination Pocket Id"},"transfer_type":{"anyOf":[{"type":"string","enum":["BANK_TRANSFER","SECURITY_TRANSFER"]},{"type":"null"}],"title":"Transfer Type"}},"type":"object","required":["type","destination_pocket_id"],"title":"OnUsInternalReallocationTransferDetails"}},"components/schemas/OnUsPeerToPeerTransferDetails":{"id":"components/schemas/OnUsPeerToPeerTransferDetails","kind":"json-schema","title":"OnUsPeerToPeerTransferDetails","data":{"properties":{"type":{"type":"string","const":"PEER_TO_PEER","title":"Type"},"destination_counterparty_id":{"type":"string","format":"uuid","title":"Destination Counterparty Id"}},"type":"object","required":["type","destination_counterparty_id"],"title":"OnUsPeerToPeerTransferDetails"}},"components/schemas/OnUsTransactionActivity":{"id":"components/schemas/OnUsTransactionActivity","kind":"json-schema","title":"OnUsTransactionActivity","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The ID of the transaction from the perspective of the respective pocket"},"transaction_id":{"type":"string","format":"uuid","title":"Transaction Id","description":"The ID of the transaction this activity is representing"},"description":{"type":"string","title":"Description","description":"A description of the transaction type, e.g. \"ACH Electronic Debit\"."},"amount":{"$ref":"#/components/schemas/Amount"},"time_booked":{"type":"string","format":"date-time","title":"Time Booked","description":"The time at which the transaction was originally booked into the ledger."},"time_settled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Time Settled","description":"The time at which transaction was settled."},"status":{"type":"string","enum":["BOOKED","SETTLED"],"title":"Status","description":"Status of the transactions. Has the transactions been settled"},"title":{"type":"string","title":"Title"},"direction":{"type":"string","enum":["DEBIT","CREDIT"],"title":"Direction"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":"The pocket associated with the transaction"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"The customer associated with the transaction"},"remittance_information":{"anyOf":[{"$ref":"#/components/schemas/RemittanceInformation"},{"type":"null"}]},"type":{"type":"string","const":"ON_US","title":"Type"},"on_us_transfer_id":{"type":"string","title":"On Us Transfer Id"},"on_us_transfer_type":{"type":"string","title":"On Us Transfer Type"},"counterparty_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty Name"},"associated_pocket_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Associated Pocket Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the pocket on the other half of INTERNAL_REALLOCATION ON_US transfer."},"children":[]}]}]}]},"end_to_end_identification":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End To End Identification"}},"type":"object","required":["id","transaction_id","description","amount","time_booked","time_settled","status","title","direction","pocket_id","customer_id","type","on_us_transfer_id","on_us_transfer_type"],"title":"OnUsTransactionActivity"}},"components/schemas/OnUsTransfer":{"id":"components/schemas/OnUsTransfer","kind":"json-schema","title":"OnUsTransfer","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"type":{"type":"string","const":"ON_US","title":"Type"},"origin_pocket_id":{"type":"string","format":"uuid","title":"Origin Pocket Id"},"amount":{"anyOf":[{"$ref":"#/components/schemas/RequestedAmount"},{"$ref":"#/components/schemas/FullWithdrawal"}],"title":"Amount"},"details":{"anyOf":[{"$ref":"#/components/schemas/OnUsPeerToPeerTransferDetails"},{"$ref":"#/components/schemas/OnUsInternalReallocationTransferDetails"}],"title":"Details"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"end_to_end_identification":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End To End Identification"}},"type":"object","required":["id","type","origin_pocket_id","amount","details"],"title":"OnUsTransfer"}},"components/schemas/OnUsTransferEvent":{"id":"components/schemas/OnUsTransferEvent","kind":"json-schema","title":"OnUsTransferEvent","data":{"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/OnUsTransferPayload"},"event_type":{"type":"string","enum":["transfers.on-us.success","transfers.on-us.processing","transfers.on-us.rejected"],"title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"OnUsTransferEvent"}},"components/schemas/OnUsTransferPayload":{"id":"components/schemas/OnUsTransferPayload","kind":"json-schema","title":"OnUsTransferPayload","data":{"properties":{"on_us_id":{"type":"string","format":"uuid","title":"On Us Id"},"origin_account_id":{"type":"string","format":"uuid","title":"Origin Account Id"},"destination_account_id":{"type":"string","format":"uuid","title":"Destination Account Id"}},"type":"object","required":["on_us_id","origin_account_id","destination_account_id"],"title":"OnUsTransferPayload"}},"components/schemas/OnUsTransferQuote":{"id":"components/schemas/OnUsTransferQuote","kind":"json-schema","title":"OnUsTransferQuote","data":{"properties":{"is_allowed":{"type":"boolean","title":"Is Allowed","description":"Whether the proposed transfer would be permitted at evaluation time."},"rejection_reason":{"anyOf":[{"type":"string","enum":["ACCOUNT_UNAVAILABLE","CANCELED","INSUFFICIENT_FUNDS","INVALID_CURRENCY","INVALID_TRANSFER","SANCTION_SCREEN_FAILED"]},{"type":"null"}],"title":"Rejection Reason","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rejection reason when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_allowed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is false; null otherwise."},"children":[]}]}]}]},"rejection_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rejection Detail","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human-readable explanation of the rejection; null when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_allowed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true."},"children":[]}]}]}]},"settlement_type":{"type":"string","title":"Settlement Type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement type the transfer would receive, e.g. \"T+0\" or \"T+1\"."},"children":[]}]}]}]},"eligible_transfer_amount":{"$ref":"#/components/schemas/Amount","description":"Maximum amount the customer is eligible to transfer given their short-maturity holdings. Zero when the request was rejected before holdings could be evaluated."}},"type":"object","required":["is_allowed","settlement_type","eligible_transfer_amount"],"title":"OnUsTransferQuote","description":"A dry-run quote for a same-entity on-us security transfer. Indicative only:\na successful quote is not a guarantee that the transfer will book."}},"components/schemas/OnUsTransferQuoteRequest":{"id":"components/schemas/OnUsTransferQuoteRequest","kind":"json-schema","title":"OnUsTransferQuoteRequest","data":{"properties":{"origin_pocket_id":{"type":"string","format":"uuid","title":"Origin Pocket Id"},"destination_pocket_id":{"type":"string","format":"uuid","title":"Destination Pocket Id"},"amount":{"$ref":"#/components/schemas/RequestedAmount"}},"type":"object","required":["origin_pocket_id","destination_pocket_id","amount"],"title":"OnUsTransferQuoteRequest","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests a dry-run quote for a same-entity on-us security transfer between"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two of the customer's own pockets."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A quote runs the same validation and ruleset evaluation as creating the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transfer but books no trades and persists nothing. It is restricted to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instant SECURITY_TRANSFER reallocation type."},"children":[]}]}]}]}},"components/schemas/OnUsTransferReceivedEvent":{"id":"components/schemas/OnUsTransferReceivedEvent","kind":"json-schema","title":"OnUsTransferReceivedEvent","data":{"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/OnUsTransferReceivedPayload"},"event_type":{"type":"string","const":"transfers.on-us.received","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"OnUsTransferReceivedEvent"}},"components/schemas/OnUsTransferReceivedPayload":{"id":"components/schemas/OnUsTransferReceivedPayload","kind":"json-schema","title":"OnUsTransferReceivedPayload","data":{"properties":{"on_us_id":{"type":"string","format":"uuid","title":"On Us Id"},"receiving_pocket_id":{"type":"string","format":"uuid","title":"Receiving Pocket Id"},"transaction_activity_id":{"type":"string","format":"uuid","title":"Transaction Activity Id"}},"type":"object","required":["on_us_id","receiving_pocket_id","transaction_activity_id"],"title":"OnUsTransferReceivedPayload"}},"components/schemas/OtherSecurity":{"id":"components/schemas/OtherSecurity","kind":"json-schema","title":"OtherSecurity","data":{"properties":{"quantity":{"type":"integer","title":"Quantity","description":"Number of securities"},"market_value":{"$ref":"#/components/schemas/Amount","description":"The current market value of the securities"},"cusip":{"type":"string","title":"Cusip","description":"CUSIP number of security"},"jiko_mark_price":{"$ref":"#/components/schemas/Decimal","description":"Current price of security"},"description":{"type":"string","title":"Description","description":"A description of the security"},"type":{"type":"string","const":"OTHER","title":"Type"}},"type":"object","required":["quantity","market_value","cusip","jiko_mark_price","description","type"],"title":"OtherSecurity"}},"components/schemas/OutgoingWireEvent":{"id":"components/schemas/OutgoingWireEvent","kind":"json-schema","title":"OutgoingWireEvent","data":{"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/WireOutgoingPayload"},"event_type":{"type":"string","enum":["transfers.wire.out.success","transfers.wire.out.processing","transfers.wire.out.rejected"],"title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"OutgoingWireEvent"}},"components/schemas/OutgoingWireResponse":{"id":"components/schemas/OutgoingWireResponse","kind":"json-schema","title":"OutgoingWireResponse","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"status":{"type":"string","enum":["PENDING","SUCCESS","REJECTED"],"title":"Status","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the wire transfer: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"amount":{"$ref":"#/components/schemas/Amount"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also known as jiko_account_id"},"children":[]}]}]}]},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"direction":{"type":"string","const":"OUTGOING","title":"Direction","default":"OUTGOING"},"counterparty_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Counterparty Id","description":"The ID of the counterparty for this wire transfer."},"wire_tracking_info":{"anyOf":[{"$ref":"#/components/schemas/WireTrackingInfo"},{"type":"null"}],"description":"Identifiers used to track the wire through the payment network. Only present on outgoing wires that have been sent."},"client_verifiers":{"items":{"type":"string"},"type":"array","title":"Client Verifiers","description":"Identifiers (emails) of the verifiers/approvers of this wire."},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","status","amount","pocket_id","time_created","object_type"],"title":"OutgoingWireResponse"}},"components/schemas/PlaidVerification":{"id":"components/schemas/PlaidVerification","kind":"json-schema","title":"PlaidVerification","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"type":{"type":"string","const":"plaid","title":"Type"},"status":{"anyOf":[{"type":"string","enum":["PENDING_REVIEW","APPROVED","REJECTED"]},{"type":"string","enum":["VERIFICATION_EXPIRED","PENDING_AUTOMATIC_VERIFICATION","MICRO_DEPOSITS_SENT"]}],"title":"Status"},"account_number_masked":{"type":"string","title":"Account Number Masked"}},"type":"object","required":["id","description","type","status","account_number_masked"],"title":"PlaidVerification"}},"components/schemas/Pocket":{"id":"components/schemas/Pocket","kind":"json-schema","title":"Pocket","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"ID of the pocket"},"pocket_name":{"type":"string","title":"Pocket Name","description":"Pocket name"},"portfolio":{"anyOf":[{"$ref":"#/components/schemas/Portfolio"},{"type":"null"}],"description":"Total liquid cash and holdings"},"status":{"type":"string","enum":["PENDING","OPEN","FROZEN","CLOSED"],"title":"Status","description":"Pocket status"},"attributes":{"items":{"type":"string"},"type":"array","title":"Attributes"},"deposit_strategy_id":{"type":"string","title":"Deposit Strategy Id","description":"Pocket deposit trading strategy ID (Example: UST-4W)"},"reinvestment_strategy_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reinvestment Strategy Id","description":"Pocket reinvestment trading strategy ID (Example: UST-4W)"},"type":{"anyOf":[{"type":"string","enum":["JIKO_PAY","JIKO_STORE"]},{"type":"null"}],"title":"Type","description":"Pocket type"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","pocket_name","status","deposit_strategy_id","reinvestment_strategy_id","object_type"],"title":"Pocket"}},"components/schemas/PocketEarnings":{"id":"components/schemas/PocketEarnings","kind":"json-schema","title":"PocketEarnings","data":{"properties":{"earnings":{"$ref":"#/components/schemas/Amount"},"date_from":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"},"date_to":{"type":"string","format":"date","title":"Date To"},"pricing_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Pricing Timestamp"},"appreciation_per_second":{"anyOf":[{"$ref":"#/components/schemas/Decimal"},{"type":"null"}]},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id"}},"type":"object","required":["earnings","date_from","date_to","pocket_id"],"title":"PocketEarnings"}},"components/schemas/Pockets":{"id":"components/schemas/Pockets","kind":"json-schema","title":"Pockets","data":{"properties":{"offset":{"type":"integer","title":"Offset"},"count":{"type":"integer","title":"Count"},"items":{"items":{"$ref":"#/components/schemas/Pocket"},"type":"array","title":"Items","description":"Customer pockets list"},"object_type":{"type":"string","title":"Object Type","default":"List"}},"type":"object","required":["offset","count","items"],"title":"Pockets"}},"components/schemas/Portal":{"id":"components/schemas/Portal","kind":"json-schema","title":"Portal","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"},"routing_number":{"type":"string","title":"Routing Number","description":"Routing number"},"account_number":{"type":"string","title":"Account Number","description":"Account number"},"status":{"type":"string","enum":["OPEN","CLOSED"],"title":"Status","description":"Portal status"},"name":{"type":"string","maxLength":50,"title":"Name","description":"Portal name"},"payment_rails":{"items":{"type":"string","enum":["ACH","WIRE","ON_US"]},"type":"array","title":"Payment Rails","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which payment rails (ACH, WIRE, ON_US) are accepted."},"children":[]}]}]}]},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","jiko_account_id","routing_number","account_number","status","name","payment_rails","object_type"],"title":"Portal"}},"components/schemas/PortalListResponse":{"id":"components/schemas/PortalListResponse","kind":"json-schema","title":"PortalListResponse","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"anyOf":[{"$ref":"#/components/schemas/VirtualBankAccountPortal"},{"$ref":"#/components/schemas/CryptoDepositAddressPortal"}]},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"PortalListResponse"}},"components/schemas/PortalType":{"id":"components/schemas/PortalType","kind":"json-schema","title":"PortalType","data":{"oneOf":[{"$ref":"#/components/schemas/VirtualBankAccountPortal"},{"$ref":"#/components/schemas/CryptoDepositAddressPortal"}],"title":"PortalType","discriminator":{"propertyName":"type","mapping":{"CRYPTO_DEPOSIT_ADDRESS_PORTAL":"#/components/schemas/CryptoDepositAddressPortal","VIRTUAL_BANK_ACCOUNT_PORTAL":"#/components/schemas/VirtualBankAccountPortal"}}}},"components/schemas/PortalUpdateRequest":{"id":"components/schemas/PortalUpdateRequest","kind":"json-schema","title":"PortalUpdateRequest","data":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":50},{"type":"null"}],"title":"Name","description":"Portal name"},"status":{"anyOf":[{"type":"string","const":"CLOSED"},{"type":"null"}],"title":"Status","description":"Portal status"}},"type":"object","title":"PortalUpdateRequest"}},"components/schemas/Portfolio":{"id":"components/schemas/Portfolio","kind":"json-schema","title":"Portfolio","data":{"properties":{"securities":{"items":{"oneOf":[{"$ref":"#/components/schemas/FixedIncomeSecurity"},{"$ref":"#/components/schemas/OtherSecurity"}],"title":"Securities currently held by the brokerage account","discriminator":{"propertyName":"type","mapping":{"FIXED_INCOME":"#/components/schemas/FixedIncomeSecurity","OTHER":"#/components/schemas/OtherSecurity"}}},"type":"array","title":"Securities"},"cash":{"$ref":"#/components/schemas/Amount","description":"Cash currently held in the brokerage account."},"all_time_earnings":{"anyOf":[{"$ref":"#/components/schemas/Amount"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All time portfolio earnings. Use of this field is discouraged, as it will be removed in a future release. Please use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/pockets/get-earnings-v2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Earnings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint instead."},"children":[]}]}]}]},"total_value":{"$ref":"#/components/schemas/Amount","description":"Total value, in USD cents"},"fees":{"items":{"oneOf":[{"$ref":"#/components/schemas/AUMFee"}],"title":"Outstanding fees for the account","discriminator":{"propertyName":"type","mapping":{"AUM_FEE":"#/components/schemas/AUMFee"}}},"type":"array","title":"Fees","description":"Any outstanding fees"},"liquidation_value_t0":{"$ref":"#/components/schemas/Amount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available liquid amount at T+0"},"children":[]}]}]}]},"liquidation_value_t1":{"anyOf":[{"$ref":"#/components/schemas/Amount"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available liquid amount at T+1"},"children":[]}]}]}]},"pricing_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Pricing Timestamp","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp at which "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was priced. Populated for pockets backed by accounts with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"real_time_yield"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute when at least one underlying CUSIP holding has real-time pricing; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" otherwise."},"children":[]}]}]}]},"appreciation_per_second":{"anyOf":[{"$ref":"#/components/schemas/Decimal"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate at which "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accrues per second, in USD cents. Combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricing_timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", allows interpolating the displayed total value forward as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_value + appreciation_per_second × (now - pricing_timestamp)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Populated for pockets backed by accounts with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"real_time_yield"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute when at least one underlying CUSIP holding has real-time pricing; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" otherwise."},"children":[]}]}]}]}},"type":"object","required":["securities","cash","total_value","fees","liquidation_value_t0"],"title":"Portfolio"}},"components/schemas/PositionSummaryReport":{"id":"components/schemas/PositionSummaryReport","kind":"json-schema","title":"PositionSummaryReport","data":{"properties":{"pocket_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Pocket Ids"},"date":{"type":"string","format":"date","title":"Date"},"type":{"type":"string","const":"POSITION_SUMMARY_REPORT","title":"Type"}},"type":"object","required":["pocket_ids","date","type"],"title":"PositionSummaryReport"}},"components/schemas/PreVerifiedVerification":{"id":"components/schemas/PreVerifiedVerification","kind":"json-schema","title":"PreVerifiedVerification","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"type":{"type":"string","const":"pre_verified","title":"Type"},"status":{"type":"string","enum":["PENDING_REVIEW","APPROVED","REJECTED"],"title":"Status"}},"type":"object","required":["id","description","type","status"],"title":"PreVerifiedVerification"}},"components/schemas/ReceiverBank":{"id":"components/schemas/ReceiverBank","kind":"json-schema","title":"ReceiverBank","data":{"properties":{"routing_number":{"type":"string","title":"Routing Number","description":"ABA routing number"},"swift":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Swift","description":"SWIFT/BIC code"},"name":{"type":"string","title":"Name","description":"Bank name"},"address":{"type":"string","title":"Address","description":"Bank address"}},"type":"object","required":["routing_number","name","address"],"title":"ReceiverBank"}},"components/schemas/RejectReason":{"id":"components/schemas/RejectReason","kind":"json-schema","title":"RejectReason","data":{"type":"string","enum":["ACCOUNT_UNAVAILABLE","CANCELED","INSUFFICIENT_FUNDS","INVALID_CURRENCY","INVALID_TRANSFER","OTHER"],"title":"RejectReason"}},"components/schemas/RelatedPartyApplicationRequest":{"id":"components/schemas/RelatedPartyApplicationRequest","kind":"json-schema","title":"RelatedPartyApplicationRequest","data":{"properties":{"name":{"anyOf":[{"$ref":"#/components/schemas/Name"},{"type":"null"}]},"address":{"anyOf":[{"$ref":"#/components/schemas/ISOAddressRequest"},{"type":"null"}]},"date_of_birth":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Of Birth"},"identification_number":{"anyOf":[{"$ref":"#/components/schemas/CreateIndividualIdentificationNumber"},{"type":"null"}]},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"roles":{"anyOf":[{"items":{"type":"string","enum":["CONTROL_PERSON","AUTHORIZED_REPRESENTATIVE"]},"type":"array"},{"type":"null"}],"title":"Roles"},"ownership_percentage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ownership Percentage","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The related party's ownership stake, as a string parseable to a number between 0 and 1 (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"0.51\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for 51%)."},"children":[]}]}]}]},"citizenship":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Citizenship"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"}},"type":"object","title":"RelatedPartyApplicationRequest"}},"components/schemas/RelatedPartyApplicationResponse":{"id":"components/schemas/RelatedPartyApplicationResponse","kind":"json-schema","title":"RelatedPartyApplicationResponse","data":{"properties":{"name":{"anyOf":[{"$ref":"#/components/schemas/Name"},{"type":"null"}]},"address":{"anyOf":[{"$ref":"#/components/schemas/ISOAddress"},{"type":"null"}]},"date_of_birth":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Of Birth"},"identification_number":{"anyOf":[{"$ref":"#/components/schemas/IndividualIdentificationNumberMasked"},{"type":"null"}]},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"roles":{"anyOf":[{"items":{"type":"string","enum":["CONTROL_PERSON","AUTHORIZED_REPRESENTATIVE"]},"type":"array"},{"type":"null"}],"title":"Roles"},"ownership_percentage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ownership Percentage","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The related party's ownership stake, as a string parseable to a number between 0 and 1 (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"0.51\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for 51%)."},"children":[]}]}]}]},"citizenship":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Citizenship"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"id":{"type":"string","format":"uuid","title":"Id"}},"type":"object","required":["identification_number","id"],"title":"RelatedPartyApplicationResponse"}},"components/schemas/RelatedPartyInviteRequest":{"id":"components/schemas/RelatedPartyInviteRequest","kind":"json-schema","title":"RelatedPartyInviteRequest","data":{"properties":{"emails":{"items":{"type":"string"},"type":"array","title":"Emails"},"invitation_type":{"type":"string","const":"INVITE_RELATED_PARTY","title":"Invitation Type"},"related_party_application_id":{"type":"string","title":"Related Party Application Id"}},"type":"object","required":["emails","invitation_type","related_party_application_id"],"title":"RelatedPartyInviteRequest"}},"components/schemas/RemittanceInfo":{"id":"components/schemas/RemittanceInfo","kind":"json-schema","title":"RemittanceInfo","data":{"properties":{"purpose":{"type":"string","title":"Purpose","description":"Remittance purpose"}},"type":"object","required":["purpose"],"title":"RemittanceInfo"}},"components/schemas/RemittanceInformation":{"id":"components/schemas/RemittanceInformation","kind":"json-schema","title":"RemittanceInformation","data":{"properties":{"unstructured":{"type":"string","maxLength":200,"title":"Unstructured","description":"Unstructured information provided by the originator of the transaction.","default":""}},"type":"object","title":"RemittanceInformation"}},"components/schemas/Report":{"id":"components/schemas/Report","kind":"json-schema","title":"Report","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"file_name":{"type":"string","title":"File Name"},"mime_type":{"type":"string","title":"Mime Type"},"status":{"type":"string","enum":["PENDING","AVAILABLE","FAILED"],"title":"Status"},"type":{"type":"string","title":"Type"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"format":{"anyOf":[{"$ref":"#/components/schemas/ReportFormat"},{"type":"null"}]}},"type":"object","required":["id","file_name","mime_type","status","type","metadata","created_at"],"title":"Report"}},"components/schemas/ReportDownload":{"id":"components/schemas/ReportDownload","kind":"json-schema","title":"ReportDownload","data":{"properties":{"download_url":{"type":"string","title":"Download Url"},"expires":{"type":"string","format":"date-time","title":"Expires"}},"type":"object","required":["download_url","expires"],"title":"ReportDownload"}},"components/schemas/ReportFormat":{"id":"components/schemas/ReportFormat","kind":"json-schema","title":"ReportFormat","data":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"}},"type":"object","required":["id","name","description"],"title":"ReportFormat"}},"components/schemas/ReportRequest":{"id":"components/schemas/ReportRequest","kind":"json-schema","title":"ReportRequest","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"type":{"type":"string","title":"Type"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"reports":{"items":{"$ref":"#/components/schemas/Report"},"type":"array","title":"Reports"}},"type":"object","required":["id","type","metadata","created_at","reports"],"title":"ReportRequest"}},"components/schemas/ReportRequestListResponse":{"id":"components/schemas/ReportRequestListResponse","kind":"json-schema","title":"ReportRequestListResponse","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"$ref":"#/components/schemas/ReportRequest"},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"ReportRequestListResponse"}},"components/schemas/RequestedAmount":{"id":"components/schemas/RequestedAmount","kind":"json-schema","title":"RequestedAmount","data":{"properties":{"type":{"type":"string","const":"REQUESTED_AMOUNT","title":"Type"},"amount":{"$ref":"#/components/schemas/Amount"}},"type":"object","required":["type","amount"],"title":"RequestedAmount"}},"components/schemas/RetryPolicy":{"id":"components/schemas/RetryPolicy","kind":"json-schema","title":"RetryPolicy","data":{"properties":{"retry_on_status_codes":{"items":{"type":"integer"},"type":"array","title":"Retry On Status Codes","description":"Denotes on which status codes Jiko will retry the webhook call, e.g. 502 or 503."},"backoff_coefficient":{"type":"number","maximum":5,"minimum":1,"title":"Backoff Coefficient"},"maximum_attempts":{"type":"integer","maximum":5,"minimum":1,"title":"Maximum Attempts"},"initial_interval_seconds":{"type":"number","maximum":30,"minimum":0,"title":"Initial Interval Seconds"},"maximum_interval_seconds":{"type":"number","maximum":300,"minimum":0,"title":"Maximum Interval Seconds"}},"type":"object","required":["retry_on_status_codes","backoff_coefficient","maximum_attempts","initial_interval_seconds","maximum_interval_seconds"],"title":"RetryPolicy"}},"components/schemas/RiskInfo":{"id":"components/schemas/RiskInfo","kind":"json-schema","title":"RiskInfo","data":{"properties":{"risk_categories":{"anyOf":[{"items":{"type":"string","enum":["INTERNET_GAMBLING","CANNABIS","CRYPTOCURRENCY","CROWDFUNDING","FINANCIAL_OR_MONEY_MOVEMENT","NON_US_ENTITY","FINTECH_OR_BAAS"]},"type":"array"},{"type":"null"}],"title":"Risk Categories"},"company_mission":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Mission"},"has_current_enforcement_actions":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Current Enforcement Actions"},"primary_regulator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Primary Regulator"},"business_activity_location":{"anyOf":[{"type":"string","enum":["PRIMARILY_US","MIX_OF_US_AND_NON_US","PRIMARILY_NON_US"]},{"type":"null"}],"title":"Business Activity Location"},"source_of_funds":{"anyOf":[{"type":"string","enum":["INTERNAL_FUNDS","CLIENT_OR_EXTERNAL_FUNDS","CRYPTOCURRENCY_EXCESS_RESERVES","CRYPTOCURRENCY_STABLECOIN_RESERVES"]},{"type":"null"}],"title":"Source Of Funds"},"source_of_funds_explanation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Of Funds Explanation"},"account_usage":{"anyOf":[{"type":"string","enum":["MONEY_STORAGE","MONEY_STORAGE_US_BANKS","MONEY_STORAGE_NON_US_BANKS","3RD_PARTY_PAYMENTS","CRYPTOCURRENCY_EXCESS_RESERVES","CRYPTOCURRENCY_STABLECOIN_RESERVES"]},{"type":"null"}],"title":"Account Usage"},"annual_revenue":{"anyOf":[{"type":"string","enum":["PRE_REVENUE","5M_OR_LESS","BETWEEN_5M_100M","100M_OR_MORE"]},{"type":"null"}],"title":"Annual Revenue"},"monthly_transactions":{"anyOf":[{"type":"string","enum":["5_OR_LESS","BETWEEN_5_AND_15","15_OR_MORE"]},{"type":"null"}],"title":"Monthly Transactions"},"first_month_deposit":{"anyOf":[{"type":"string","enum":["1M_OR_LESS","BETWEEN_1M_AND_5M","BETWEEN_5M_AND_20M","BETWEEN_20M_AND_50M","50M_OR_MORE"]},{"type":"null"}],"title":"First Month Deposit"}},"type":"object","title":"RiskInfo"}},"components/schemas/Role":{"id":"components/schemas/Role","kind":"json-schema","title":"Role","data":{"type":"string","enum":["ADMINISTRATOR","MAKER","CHECKER","VIEWER","USER_ADMINISTRATOR"],"title":"Role"}},"components/schemas/SameEntityTransferTrade":{"id":"components/schemas/SameEntityTransferTrade","kind":"json-schema","title":"SameEntityTransferTrade","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for this trade"},"trade_datetime":{"type":"string","format":"date-time","title":"Trade Datetime","description":"The date and time at which the trade was executed"},"book_date":{"type":"string","format":"date","title":"Book Date","description":"The date on which the trade was booked into the ledger"},"settled_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Settled Date","description":"The date on which the trade was settled, or null if not yet settled"},"status":{"type":"string","enum":["BOOKED","SETTLED"],"title":"Status","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current status of the trade: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BOOKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLED"},"children":[]}]}]}]},"activity":{"type":"string","const":"SAME_ENTITY_SECURITY_TRANSFER","title":"Activity","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of trade activity: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SELL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MATURITY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXTERNAL_SECURITY_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAME_ENTITY_SECURITY_TRANSFER"},"children":[]}]}]}]},"origin_pocket_id":{"type":"string","format":"uuid","title":"Origin Pocket Id","description":"The pocket from which securities are being transferred"},"destination_pocket_id":{"type":"string","format":"uuid","title":"Destination Pocket Id","description":"The pocket to which securities are being transferred"},"securities":{"items":{"$ref":"#/components/schemas/CusipSecurity"},"type":"array","title":"Securities","description":"The securities being transferred"},"currency_legs":{"items":{"$ref":"#/components/schemas/CurrencyLeg"},"type":"array","title":"Currency Legs","description":"Currency movements associated with this transfer"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","trade_datetime","book_date","settled_date","status","activity","origin_pocket_id","destination_pocket_id","securities","currency_legs","object_type"],"title":"SameEntityTransferTrade","description":"A same-entity transfer trade representing a direct movement of securities between two pockets belonging to the same customer."}},"components/schemas/SecurityPriceReport":{"id":"components/schemas/SecurityPriceReport","kind":"json-schema","title":"SecurityPriceReport","data":{"properties":{"securities":{"items":{"type":"string"},"type":"array","title":"Securities","default":[]},"start_date":{"type":"string","format":"date","title":"Start Date"},"end_date":{"type":"string","format":"date","title":"End Date"},"type":{"type":"string","const":"SECURITY_PRICE_REPORT","title":"Type"}},"type":"object","required":["start_date","end_date","type"],"title":"SecurityPriceReport"}},"components/schemas/SecurityTransferTrade":{"id":"components/schemas/SecurityTransferTrade","kind":"json-schema","title":"SecurityTransferTrade","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for this trade"},"trade_datetime":{"type":"string","format":"date-time","title":"Trade Datetime","description":"The date and time at which the trade was executed"},"book_date":{"type":"string","format":"date","title":"Book Date","description":"The date on which the trade was booked into the ledger"},"settled_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Settled Date","description":"The date on which the trade was settled, or null if not yet settled"},"status":{"type":"string","enum":["BOOKED","SETTLED"],"title":"Status","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current status of the trade: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BOOKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLED"},"children":[]}]}]}]},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":"The pocket this trade is listed under"},"activity":{"type":"string","const":"EXTERNAL_SECURITY_TRANSFER","title":"Activity","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of trade activity: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SELL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MATURITY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXTERNAL_SECURITY_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAME_ENTITY_SECURITY_TRANSFER"},"children":[]}]}]}]},"securities":{"items":{"$ref":"#/components/schemas/CusipSecurity"},"type":"array","title":"Securities","description":"The securities being transferred"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","trade_datetime","book_date","settled_date","status","pocket_id","activity","securities","object_type"],"title":"SecurityTransferTrade","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security transfer trade representing securities moving in or out of a pocket."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yield_to_maturity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" because a transfer is not priced like a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"trade — it just moves existing securities between accounts."},"children":[]}]}]}]}},"components/schemas/ServiceTeamMember":{"id":"components/schemas/ServiceTeamMember","kind":"json-schema","title":"ServiceTeamMember","data":{"properties":{"member_id":{"type":"string","format":"uuid","title":"Member Id"},"last_login":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Login"},"display_name":{"type":"string","title":"Display Name"},"email":{"type":"string","title":"Email"},"role":{"$ref":"#/components/schemas/Role"},"status":{"$ref":"#/components/schemas/MembershipStatus"},"added_date":{"type":"string","format":"date-time","title":"Added Date"},"deactivated_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deactivated Date"},"user_id":{"type":"string","format":"uuid","title":"User Id"}},"type":"object","required":["member_id","last_login","display_name","email","role","status","added_date","deactivated_date","user_id"],"title":"ServiceTeamMember"}},"components/schemas/StandardTrade":{"id":"components/schemas/StandardTrade","kind":"json-schema","title":"StandardTrade","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for this trade"},"trade_datetime":{"type":"string","format":"date-time","title":"Trade Datetime","description":"The date and time at which the trade was executed"},"book_date":{"type":"string","format":"date","title":"Book Date","description":"The date on which the trade was booked into the ledger"},"settled_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Settled Date","description":"The date on which the trade was settled, or null if not yet settled"},"status":{"type":"string","enum":["BOOKED","SETTLED"],"title":"Status","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current status of the trade: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BOOKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLED"},"children":[]}]}]}]},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":"The pocket this trade is listed under"},"activity":{"type":"string","enum":["BUY","SELL","MATURITY"],"title":"Activity","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of trade activity: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SELL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MATURITY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXTERNAL_SECURITY_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAME_ENTITY_SECURITY_TRANSFER"},"children":[]}]}]}]},"securities":{"items":{"$ref":"#/components/schemas/CusipSecurity"},"type":"array","title":"Securities","description":"The securities involved in this trade"},"yield_to_maturity":{"$ref":"#/components/schemas/Decimal","description":"Rate of return if the security is held to the maturity date"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","trade_datetime","book_date","settled_date","status","pocket_id","activity","securities","yield_to_maturity","object_type"],"title":"StandardTrade","description":"A standard trade representing a BUY, SELL, or MATURITY event for a single pocket."}},"components/schemas/Statement":{"id":"components/schemas/Statement","kind":"json-schema","title":"Statement","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"jiko_account_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Jiko Account Id"},"type":{"type":"string","enum":["1099B","1099INT","BANK","BROKERAGE","CONSOLIDATED_BANK","CONSOLIDATED_BROKERAGE"],"title":"Type"},"key":{"type":"string","title":"Key"},"pdf_download_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Pdf Download Url"},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"csv_zip_download_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Csv Zip Download Url"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","jiko_account_id","type","key","pdf_download_url","time_created","csv_zip_download_url","object_type"],"title":"Statement"}},"components/schemas/StatementListResponse":{"id":"components/schemas/StatementListResponse","kind":"json-schema","title":"StatementListResponse","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"$ref":"#/components/schemas/Statement"},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"StatementListResponse"}},"components/schemas/Subscription":{"id":"components/schemas/Subscription","kind":"json-schema","title":"Subscription","data":{"properties":{"description":{"type":"string","title":"Description","description":"A description of the webhook's intended use.","default":""},"events":{"items":{"type":"string"},"type":"array","minItems":1,"title":"Events","description":"Which types of events this webhook should be invoked for."},"url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Url","description":"The webhook URL to invoke."},"retry_policy":{"anyOf":[{"$ref":"#/components/schemas/RetryPolicy"},{"type":"null"}],"description":"The retry policy to use if Jiko encounters HTTP errors when calling subscription URLs."},"id":{"type":"string","format":"uuid","title":"Id"},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"status":{"type":"string","enum":["enabled","disabled"],"title":"Status"}},"type":"object","required":["events","url","id","time_created","updated_at","status"],"title":"Subscription"}},"components/schemas/SupportingDocument":{"id":"components/schemas/SupportingDocument","kind":"json-schema","title":"SupportingDocument","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"document_id":{"type":"string","format":"uuid","title":"Document Id"},"status":{"type":"string","enum":["PENDING_REVIEW","APPROVED","REJECTED"],"title":"Status"}},"type":"object","required":["id","document_id","status"],"title":"SupportingDocument"}},"components/schemas/SupportingDocumentsVerification":{"id":"components/schemas/SupportingDocumentsVerification","kind":"json-schema","title":"SupportingDocumentsVerification","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"type":{"type":"string","const":"supporting_documents","title":"Type"},"supporting_documents":{"items":{"$ref":"#/components/schemas/SupportingDocument"},"type":"array","title":"Supporting Documents"},"status":{"type":"string","enum":["PENDING_REVIEW","APPROVED","REJECTED"],"title":"Status"}},"type":"object","required":["id","description","type","supporting_documents","status"],"title":"SupportingDocumentsVerification"}},"components/schemas/TeamMember":{"id":"components/schemas/TeamMember","kind":"json-schema","title":"TeamMember","data":{"properties":{"member_id":{"type":"string","format":"uuid","title":"Member Id"},"last_login":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Login"},"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"},"email":{"type":"string","title":"Email"},"role":{"$ref":"#/components/schemas/Role"},"status":{"$ref":"#/components/schemas/MembershipStatus"},"added_date":{"type":"string","format":"date-time","title":"Added Date"},"deactivated_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deactivated Date"},"phone_number":{"type":"string","title":"Phone Number"},"user_id":{"type":"string","format":"uuid","title":"User Id"}},"type":"object","required":["member_id","last_login","first_name","last_name","email","role","status","added_date","deactivated_date","phone_number","user_id"],"title":"TeamMember"}},"components/schemas/TeamMemberResponse":{"id":"components/schemas/TeamMemberResponse","kind":"json-schema","title":"TeamMemberResponse","data":{"properties":{"member_id":{"type":"string","format":"uuid","title":"Member Id"},"email":{"type":"string","title":"Email"},"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"},"role":{"$ref":"#/components/schemas/Role"},"status":{"$ref":"#/components/schemas/MembershipStatus"},"added_date":{"type":"string","format":"date-time","title":"Added Date"},"last_login":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Login"},"deactivated_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deactivated Date"},"team_id":{"type":"string","format":"uuid","title":"Team Id"},"partner_id":{"type":"string","format":"uuid","title":"Partner Id"},"user_id":{"type":"string","format":"uuid","title":"User Id"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"}},"type":"object","required":["member_id","email","first_name","last_name","role","status","added_date","last_login","deactivated_date","team_id","partner_id","user_id","phone_number"],"title":"TeamMemberResponse"}},"components/schemas/TeamResponse":{"id":"components/schemas/TeamResponse","kind":"json-schema","title":"TeamResponse","data":{"properties":{"team_id":{"type":"string","format":"uuid","title":"Team Id"},"members_by_status":{"items":{"$ref":"#/components/schemas/MemberGroup"},"type":"array","title":"Members By Status"},"allowed_authentication_methods":{"items":{"$ref":"#/components/schemas/AuthenticationMethod"},"type":"array","title":"Allowed Authentication Methods"},"service_users":{"items":{"$ref":"#/components/schemas/ServiceTeamMember"},"type":"array","title":"Service Users"}},"type":"object","required":["team_id","members_by_status","allowed_authentication_methods","service_users"],"title":"TeamResponse"}},"components/schemas/Trade":{"id":"components/schemas/Trade","kind":"json-schema","title":"Trade","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"trade_datetime":{"type":"string","format":"date-time","title":"Trade Datetime"},"settled_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Settled Date"},"is_settled":{"type":"boolean","title":"Is Settled"},"activity":{"type":"string","enum":["BUY","SELL","MATURITY"],"title":"Activity"},"cusip":{"type":"string","title":"Cusip"},"description":{"type":"string","title":"Description"},"notional":{"$ref":"#/components/schemas/Amount"},"quantity":{"type":"integer","title":"Quantity"},"price":{"$ref":"#/components/schemas/Decimal"},"maturity_date":{"type":"string","format":"date","title":"Maturity Date"},"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"},"yield_to_maturity":{"$ref":"#/components/schemas/Decimal"},"tradable_id":{"type":"string","title":"Tradable Id"},"book_date":{"type":"string","format":"date","title":"Book Date"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","trade_datetime","settled_date","is_settled","activity","cusip","description","notional","quantity","price","maturity_date","jiko_account_id","yield_to_maturity","tradable_id","book_date","object_type"],"title":"Trade"}},"components/schemas/TradeListResponse":{"id":"components/schemas/TradeListResponse","kind":"json-schema","title":"TradeListResponse","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"$ref":"#/components/schemas/Trade"},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"TradeListResponse"}},"components/schemas/TradeListResponseV2":{"id":"components/schemas/TradeListResponseV2","kind":"json-schema","title":"TradeListResponseV2","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"oneOf":[{"$ref":"#/components/schemas/StandardTrade"},{"$ref":"#/components/schemas/SecurityTransferTrade"},{"$ref":"#/components/schemas/SameEntityTransferTrade"}],"discriminator":{"propertyName":"activity","mapping":{"BUY":"#/components/schemas/StandardTrade","EXTERNAL_SECURITY_TRANSFER":"#/components/schemas/SecurityTransferTrade","MATURITY":"#/components/schemas/StandardTrade","SAME_ENTITY_SECURITY_TRANSFER":"#/components/schemas/SameEntityTransferTrade","SELL":"#/components/schemas/StandardTrade"}}},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"TradeListResponseV2"}},"components/schemas/TradeReport":{"id":"components/schemas/TradeReport","kind":"json-schema","title":"TradeReport","data":{"properties":{"pocket_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Pocket Ids"},"start_date":{"type":"string","format":"date","title":"Start Date"},"end_date":{"type":"string","format":"date","title":"End Date"},"filter_by_date_type":{"type":"string","enum":["trade_date","settlement_date","book_date"],"title":"Filter By Date Type","default":"trade_date"},"include_maturity_events":{"type":"boolean","title":"Include Maturity Events","default":false},"type":{"type":"string","const":"TRADE_REPORT","title":"Type"}},"type":"object","required":["pocket_ids","start_date","end_date","type"],"title":"TradeReport"}},"components/schemas/TradingStrategies":{"id":"components/schemas/TradingStrategies","kind":"json-schema","title":"TradingStrategies","data":{"properties":{"offset":{"type":"integer","title":"Offset"},"count":{"type":"integer","title":"Count"},"items":{"items":{"$ref":"#/components/schemas/TradingStrategy"},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"List"},"last_updated":{"type":"string","format":"date-time","title":"Last Updated","description":"Timestamp that reflects when the Jiko quote was fetched"}},"type":"object","required":["offset","count","items","last_updated"],"title":"TradingStrategies"}},"components/schemas/TradingStrategy":{"id":"components/schemas/TradingStrategy","kind":"json-schema","title":"TradingStrategy","data":{"properties":{"id":{"type":"string","title":"Id"},"description":{"type":"string","title":"Description"},"yield_to_maturity":{"anyOf":[{"$ref":"#/components/schemas/Decimal"},{"type":"null"}]},"discount_yield":{"anyOf":[{"$ref":"#/components/schemas/Decimal"},{"type":"null"}]},"applicable_to":{"items":{"type":"string","enum":["DEPOSIT","REINVESTMENT"]},"type":"array","title":"Applicable To"}},"type":"object","required":["id","description","yield_to_maturity","discount_yield","applicable_to"],"title":"TradingStrategy"}},"components/schemas/TransactionLocation":{"id":"components/schemas/TransactionLocation","kind":"json-schema","title":"TransactionLocation","data":{"properties":{"street_address":{"type":"string","title":"Street Address"},"city":{"type":"string","title":"City"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"country":{"type":"string","title":"Country"}},"type":"object","required":["street_address","city","country"],"title":"TransactionLocation"}},"components/schemas/TransferRequest":{"id":"components/schemas/TransferRequest","kind":"json-schema","title":"TransferRequest","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"team_id":{"type":"string","format":"uuid","title":"Team Id"},"created_by_user":{"$ref":"#/components/schemas/DualAuthUser"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"reviewed_by_user":{"anyOf":[{"$ref":"#/components/schemas/DualAuthUser"},{"type":"null"}]},"reviewed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reviewed At"},"denial_reason":{"anyOf":[{"$ref":"#/components/schemas/DenialReason"},{"type":"null"}]},"denial_other_memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Denial Other Memo"},"status":{"$ref":"#/components/schemas/TransferRequestStatus"},"transfer":{"anyOf":[{"$ref":"#/components/schemas/WireTransfer"},{"$ref":"#/components/schemas/OnUsTransfer"},{"$ref":"#/components/schemas/UsdcTransfer"}],"title":"Transfer"},"reviewers":{"items":{"$ref":"#/components/schemas/DualAuthUser"},"type":"array","title":"Reviewers"},"reject_reason":{"anyOf":[{"$ref":"#/components/schemas/RejectReason"},{"type":"null"}]}},"type":"object","required":["id","team_id","created_by_user","created_at","status","transfer","reviewers"],"title":"TransferRequest"}},"components/schemas/TransferRequestEvent":{"id":"components/schemas/TransferRequestEvent","kind":"json-schema","title":"TransferRequestEvent","data":{"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/TransferRequestPayload"},"event_type":{"type":"string","enum":["transfer-request.status.approved","transfer-request.status.canceled","transfer-request.status.denied","transfer-request.status.processed","transfer-request.status.processing","transfer-request.status.rejected"],"title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"TransferRequestEvent"}},"components/schemas/TransferRequestPayload":{"id":"components/schemas/TransferRequestPayload","kind":"json-schema","title":"TransferRequestPayload","data":{"properties":{"transfer_request_id":{"type":"string","format":"uuid","title":"Transfer Request Id"},"transfer_id":{"type":"string","format":"uuid","title":"Transfer Id"}},"type":"object","required":["transfer_request_id","transfer_id"],"title":"TransferRequestPayload"}},"components/schemas/TransferRequestStatus":{"id":"components/schemas/TransferRequestStatus","kind":"json-schema","title":"TransferRequestStatus","data":{"type":"string","enum":["UNDER_REVIEW","APPROVED","PROCESSING","PROCESSED","REJECTED","CANCELED","DENIED"],"title":"TransferRequestStatus"}},"components/schemas/TransferRequestsResponse":{"id":"components/schemas/TransferRequestsResponse","kind":"json-schema","title":"TransferRequestsResponse","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"$ref":"#/components/schemas/TransferRequest"},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"TransferRequestsResponse"}},"components/schemas/TrustedContact":{"id":"components/schemas/TrustedContact","kind":"json-schema","title":"TrustedContact","data":{"properties":{"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An E.164-formatted phone number, e.g. +12345678901"},"children":[]}]}]}]},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The address of the trusted contact. You can use a format such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{street name}, {city}, {state}, {post code}, {country}"},"children":[]}]}]}]}},"type":"object","title":"TrustedContact"}},"components/schemas/USDCFundingInstruction":{"id":"components/schemas/USDCFundingInstruction","kind":"json-schema","title":"USDCFundingInstruction","data":{"properties":{"type":{"type":"string","const":"USDC","title":"Type"},"address":{"type":"string","title":"Address","description":"The wallet address of the portal"},"chain":{"type":"string","title":"Chain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The chain associated with the wallet address. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ETH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported at this time."},"children":[]}]}]}]}},"type":"object","required":["type","address","chain"],"title":"USDCFundingInstruction"}},"components/schemas/UnverifiedVerification":{"id":"components/schemas/UnverifiedVerification","kind":"json-schema","title":"UnverifiedVerification","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"type":{"type":"string","const":"unverified","title":"Type"}},"type":"object","required":["id","description","type"],"title":"UnverifiedVerification"}},"components/schemas/UpdateCounterpartyRequest":{"id":"components/schemas/UpdateCounterpartyRequest","kind":"json-schema","title":"UpdateCounterpartyRequest","data":{"properties":{"status":{"anyOf":[{"type":"string","const":"UNLINKED"},{"type":"null"}],"title":"Status"},"display_name":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Display Name","description":"An optional custom display name for the counterparty, useful for distinguishing multiple counterparties that share the same legal name."}},"type":"object","title":"UpdateCounterpartyRequest"}},"components/schemas/UpdateCustomerNotificationStatus":{"id":"components/schemas/UpdateCustomerNotificationStatus","kind":"json-schema","title":"UpdateCustomerNotificationStatus","data":{"properties":{"status":{"$ref":"#/components/schemas/NotificationStatus"}},"type":"object","required":["status"],"title":"UpdateCustomerNotificationStatus"}},"components/schemas/UpdatePocketRequest":{"id":"components/schemas/UpdatePocketRequest","kind":"json-schema","title":"UpdatePocketRequest","data":{"properties":{"pocket_name":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Pocket Name","description":"Pocket name"},"status":{"anyOf":[{"type":"string","const":"CLOSED"},{"type":"null"}],"title":"Status","description":"Pocket status"},"closure_reason":{"anyOf":[{"type":"string","enum":["PARTNER_INSTIGATED","USER_INSTIGATED","INACTIVITY","SUSPICIOUS_ACTIVITY"]},{"type":"null"}],"title":"Closure Reason"},"deposit_strategy_id":{"anyOf":[{"$ref":"#/components/schemas/CreatePocketConfigurationId"},{"type":"null"}],"description":"Pocket deposit trading strategy ID (Example: UST-4W)"},"reinvestment_strategy_id":{"anyOf":[{"$ref":"#/components/schemas/CreatePocketConfigurationId"},{"type":"null"}],"description":"Pocket reinvestment trading strategy ID (Example: UST-4W)"}},"type":"object","title":"UpdatePocketRequest"}},"components/schemas/UpdateRetryPolicy":{"id":"components/schemas/UpdateRetryPolicy","kind":"json-schema","title":"UpdateRetryPolicy","data":{"properties":{"retry_policy":{"anyOf":[{"$ref":"#/components/schemas/RetryPolicy"},{"type":"null"}]}},"type":"object","title":"UpdateRetryPolicy"}},"components/schemas/UpdateSubscriptionRequest":{"id":"components/schemas/UpdateSubscriptionRequest","kind":"json-schema","title":"UpdateSubscriptionRequest","data":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A description of the webhook's intended use."},"events":{"anyOf":[{"items":{"type":"string"},"type":"array","minItems":1,"description":"Which types of events this webhook should be invoked for."},{"type":"null"}],"title":"Events"},"url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Url","description":"The webhook URL to invoke."},"shared_secret":{"anyOf":[{"type":"string","minLength":16},{"type":"null"}],"title":"Shared Secret","description":"The shared secret used by the Partner API to sign requests made to the webhook. The shared secret needs to be minimum 16 characters long."},"retry_policy":{"anyOf":[{"$ref":"#/components/schemas/RetryPolicy"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["enabled","disabled"]},{"type":"null"}],"title":"Status"}},"type":"object","title":"UpdateSubscriptionRequest"}},"components/schemas/UpdateTransferRequestStatus":{"id":"components/schemas/UpdateTransferRequestStatus","kind":"json-schema","title":"UpdateTransferRequestStatus","data":{"properties":{"status":{"$ref":"#/components/schemas/TransferRequestStatus"},"denial_reason":{"anyOf":[{"$ref":"#/components/schemas/DenialReason"},{"type":"null"}]},"denial_other_memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Denial Other Memo"}},"type":"object","required":["status"],"title":"UpdateTransferRequestStatus"}},"components/schemas/UploadDocumentResponse":{"id":"components/schemas/UploadDocumentResponse","kind":"json-schema","title":"UploadDocumentResponse","data":{"properties":{"success":{"type":"boolean","title":"Success"},"document_id":{"type":"string","format":"uuid","title":"Document Id"}},"type":"object","required":["success","document_id"],"title":"UploadDocumentResponse"}},"components/schemas/UsdcTransfer":{"id":"components/schemas/UsdcTransfer","kind":"json-schema","title":"UsdcTransfer","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"type":{"type":"string","const":"USDC","title":"Type"},"counterparty_id":{"type":"string","format":"uuid","title":"Counterparty Id"},"origin_pocket_id":{"type":"string","format":"uuid","title":"Origin Pocket Id"},"amount":{"$ref":"#/components/schemas/RequestedAmount"}},"type":"object","required":["id","type","counterparty_id","origin_pocket_id","amount"],"title":"UsdcTransfer"}},"components/schemas/UserInfo":{"id":"components/schemas/UserInfo","kind":"json-schema","title":"UserInfo","data":{"properties":{"member_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Member Id"},"user_id":{"type":"string","title":"User Id"},"email":{"type":"string","title":"Email"},"name":{"type":"string","title":"Name"},"role":{"anyOf":[{"$ref":"#/components/schemas/Role"},{"type":"null"}]},"phone_number":{"type":"string","title":"Phone Number"},"dual_auth_no_reviewers_mode":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Dual Auth No Reviewers Mode"},"is_onboarding":{"type":"boolean","title":"Is Onboarding","default":false},"feature_flags":{"additionalProperties":true,"type":"object","title":"Feature Flags","default":{}}},"type":"object","required":["user_id","email","name","phone_number"],"title":"UserInfo","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response model for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]}]}},"components/schemas/ValidationError":{"id":"components/schemas/ValidationError","kind":"json-schema","title":"ValidationError","data":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"components/schemas/ValuationType":{"id":"components/schemas/ValuationType","kind":"json-schema","title":"ValuationType","data":{"type":"string","enum":["rfq","jikonet"],"title":"ValuationType"}},"components/schemas/VirtualBankAccountPortal":{"id":"components/schemas/VirtualBankAccountPortal","kind":"json-schema","title":"VirtualBankAccountPortal","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id"},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"name":{"type":"string","title":"Name","description":"Portal name"},"status":{"type":"string","enum":["OPEN","CLOSED","PENDING","REJECTED"],"title":"Status","description":"Portal status"},"type":{"type":"string","const":"VIRTUAL_BANK_ACCOUNT_PORTAL","title":"Type"},"routing_number":{"type":"string","title":"Routing Number","description":"Routing number"},"account_number":{"type":"string","title":"Account Number","description":"Account number"},"payment_rails":{"items":{"type":"string","enum":["ACH","WIRE","ON_US"]},"type":"array","title":"Payment Rails","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which payment rails (ACH, WIRE, ON_US) are accepted."},"children":[]}]}]}]}},"type":"object","required":["id","pocket_id","time_created","name","status","type","routing_number","account_number","payment_rails"],"title":"VirtualBankAccountPortal"}},"components/schemas/WireCounterpartyV2":{"id":"components/schemas/WireCounterpartyV2","kind":"json-schema","title":"Wire Counterparty","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"status":{"type":"string","enum":["PENDING","FAILED","LINKED","UNLINKED","CLOSED"],"title":"Status"},"verification":{"oneOf":[{"$ref":"#/components/schemas/SupportingDocumentsVerification"},{"$ref":"#/components/schemas/IncomingWireVerification"},{"$ref":"#/components/schemas/PreVerifiedVerification"},{"$ref":"#/components/schemas/PlaidVerification"},{"$ref":"#/components/schemas/MicroDepositsVerification"},{"$ref":"#/components/schemas/NameMatchVerification"},{"$ref":"#/components/schemas/UnverifiedVerification"}],"title":"Verification","discriminator":{"propertyName":"type","mapping":{"incoming_wire":"#/components/schemas/IncomingWireVerification","micro_deposits":"#/components/schemas/MicroDepositsVerification","name_match":"#/components/schemas/NameMatchVerification","plaid":"#/components/schemas/PlaidVerification","pre_verified":"#/components/schemas/PreVerifiedVerification","supporting_documents":"#/components/schemas/SupportingDocumentsVerification","unverified":"#/components/schemas/UnverifiedVerification"}}},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name","description":"An optional custom display name for the counterparty, useful for distinguishing multiple counterparties that share the same legal name."},"type":{"type":"string","const":"wire","title":"Type"},"counterparty_name":{"oneOf":[{"$ref":"#/components/schemas/IndividualName"},{"$ref":"#/components/schemas/BusinessName"}],"title":"Counterparty name","discriminator":{"propertyName":"type","mapping":{"business":"#/components/schemas/BusinessName","individual":"#/components/schemas/IndividualName"}}},"address":{"$ref":"#/components/schemas/CounterpartyAddress"},"institution_name":{"type":"string","title":"Institution Name"},"routing_number":{"type":"string","title":"Routing Number"},"identifier":{"type":"string","title":"Identifier"},"identifier_code":{"type":"string","enum":["SWIFT_BIC","CHIPS_PARTICIPANT","DIRECT_DEPOSIT_ACCOUNT","FED_ROUTING_NUMBER","SWIFT_ID_AND_ACCOUNT_NUMBER","CHIPS_IDENTIFIER","PASSPORT_NUMBER","TAX_IDENTIFICATION_NUMBER","DRIVERS_LICENSE_NUMBER","ALIEN_REGISTRATION_NUMBER","CORPORATE_IDENTIFICATION","OTHER_IDENTIFICATION"],"title":"Identifier Code"},"wire_instructions":{"anyOf":[{"type":"string","maxLength":140},{"type":"null"}],"title":"Wire Instructions","description":"Any additional wire instructions required for the wire to be processed correctly."},"ownership_type":{"anyOf":[{"type":"string","enum":["FIRST_PARTY","THIRD_PARTY"]},{"type":"null"}],"title":"Ownership Type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relationship of the counterparty to the account holder. FIRST_PARTY means the counterparty is owned by the account holder, THIRD_PARTY means it is owned by a different entity."},"children":[]}]}]}]},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","time_created","status","verification","type","counterparty_name","address","institution_name","routing_number","identifier","identifier_code","object_type"],"title":"Wire Counterparty"}},"components/schemas/WireIncomingPayload":{"id":"components/schemas/WireIncomingPayload","kind":"json-schema","title":"WireIncomingPayload","data":{"properties":{"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"},"wire_id":{"type":"string","format":"uuid","title":"Wire Id"}},"type":"object","required":["jiko_account_id","wire_id"],"title":"WireIncomingPayload"}},"components/schemas/WireListResponse":{"id":"components/schemas/WireListResponse","kind":"json-schema","title":"WireListResponse","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"oneOf":[{"$ref":"#/components/schemas/IncomingWireResponse"},{"$ref":"#/components/schemas/OutgoingWireResponse"}],"discriminator":{"propertyName":"direction","mapping":{"INCOMING":"#/components/schemas/IncomingWireResponse","OUTGOING":"#/components/schemas/OutgoingWireResponse"}}},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"WireListResponse"}},"components/schemas/WireOutgoingPayload":{"id":"components/schemas/WireOutgoingPayload","kind":"json-schema","title":"WireOutgoingPayload","data":{"properties":{"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"},"wire_id":{"type":"string","format":"uuid","title":"Wire Id"},"state":{"type":"string","title":"State"}},"type":"object","required":["jiko_account_id","wire_id","state"],"title":"WireOutgoingPayload"}},"components/schemas/WireTrackingInfo":{"id":"components/schemas/WireTrackingInfo","kind":"json-schema","title":"WireTrackingInfo","data":{"properties":{"uetr":{"type":"string","title":"Uetr","description":"Unique End-to-end Transaction Reference (UETR), a UUID identifying the wire across the payment network."},"imad":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Imad","description":"Input Message Accountability Data (IMAD), the Fedwire identifier for the wire. Null when not available."}},"type":"object","required":["uetr"],"title":"WireTrackingInfo"}},"components/schemas/WireTransactionActivity":{"id":"components/schemas/WireTransactionActivity","kind":"json-schema","title":"WireTransactionActivity","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The ID of the transaction from the perspective of the respective pocket"},"transaction_id":{"type":"string","format":"uuid","title":"Transaction Id","description":"The ID of the transaction this activity is representing"},"description":{"type":"string","title":"Description","description":"A description of the transaction type, e.g. \"ACH Electronic Debit\"."},"amount":{"$ref":"#/components/schemas/Amount"},"time_booked":{"type":"string","format":"date-time","title":"Time Booked","description":"The time at which the transaction was originally booked into the ledger."},"time_settled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Time Settled","description":"The time at which transaction was settled."},"status":{"type":"string","enum":["BOOKED","SETTLED"],"title":"Status","description":"Status of the transactions. Has the transactions been settled"},"title":{"type":"string","title":"Title"},"direction":{"type":"string","enum":["DEBIT","CREDIT"],"title":"Direction"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":"The pocket associated with the transaction"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"The customer associated with the transaction"},"remittance_information":{"anyOf":[{"$ref":"#/components/schemas/RemittanceInformation"},{"type":"null"}]},"type":{"type":"string","const":"WIRE","title":"Type"},"reference_number":{"type":"string","title":"Reference Number"},"counterparty_name":{"type":"string","title":"Counterparty Name"},"wire_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Wire Id"}},"type":"object","required":["id","transaction_id","description","amount","time_booked","time_settled","status","title","direction","pocket_id","customer_id","type","reference_number","counterparty_name","wire_id"],"title":"WireTransactionActivity"}},"components/schemas/WireTransfer":{"id":"components/schemas/WireTransfer","kind":"json-schema","title":"WireTransfer","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"type":{"type":"string","const":"WIRE","title":"Type"},"counterparty_id":{"type":"string","format":"uuid","title":"Counterparty Id"},"origin_pocket_id":{"type":"string","format":"uuid","title":"Origin Pocket Id"},"amount":{"$ref":"#/components/schemas/RequestedAmount"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","required":["id","type","counterparty_id","origin_pocket_id","amount"],"title":"WireTransfer"}},"schema_222":{"kind":"json-schema","data":{"type":"integer","minimum":0,"default":0,"title":"Offset"},"id":"schema_222"},"schema_223":{"kind":"json-schema","data":{"type":"integer","maximum":30,"minimum":1,"default":30,"title":"Limit"},"id":"schema_223"},"schema_224":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ValuationType"},{"type":"null"}],"title":"Valuation Type"},"id":"schema_224"},"schema_225":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"enum":["PENDING","OPEN","FROZEN","CLOSED"],"type":"string"}},{"type":"null"}],"title":"Status[]"},"id":"schema_225"},"schema_226":{"kind":"json-schema","data":{"anyOf":[{"type":"array","uniqueItems":true,"items":{"enum":["portfolio","all_time_earnings"],"type":"string"}},{"type":"null"}],"title":"Omit[]"},"id":"schema_226"},"schema_227":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Pocket Id"},"id":"schema_227"},"schema_228":{"kind":"json-schema","data":{"enum":["ytd","mtd","wtd","all-time"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period to fetch earnings for. Can be one of"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ytd (Year-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mtd (Month-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wtd (Week-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all-time"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom date ranges are not supported at the customer level; use the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single-pocket earnings endpoint with 'range' instead."},"children":[]}]}]}],"default":"all-time","title":"Period"},"id":"schema_228"},"schema_229":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":30},{"type":"null"}],"description":"Restricts the earnings to the given pockets. Defaults to all of the customer's pockets except closed ones; a closed pocket's earnings are included only when it is listed here explicitly.","title":"Pocket Id[]"},"id":"schema_229"},"schema_230":{"kind":"json-schema","data":{"type":"string","title":"Pocket Id"},"id":"schema_230"},"schema_231":{"kind":"json-schema","data":{"enum":["ytd","mtd","wtd","all-time","range"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period to fetch earnings for. Can be one of"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ytd (Year-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mtd (Month-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wtd (Week-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all-time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"range"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When 'range' is chosen, you need to specify 'date_from' and 'date_to' (inclusive)."},"children":[]}]}]}],"default":"all-time","title":"Period"},"id":"schema_231"},"schema_232":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"},"id":"schema_232"},"schema_233":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"},"id":"schema_233"},"schema_234":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"enum":["VIRTUAL_BANK_ACCOUNT_PORTAL","CRYPTO_DEPOSIT_ADDRESS_PORTAL"],"type":"string"}},{"type":"null"}],"title":"Type[]"},"id":"schema_234"},"schema_235":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"enum":["OPEN","CLOSED","PENDING","REJECTED"],"type":"string"}},{"type":"null"}],"title":"Status[]"},"id":"schema_235"},"schema_236":{"kind":"json-schema","data":{"type":"string","default":"","title":"Cursor"},"id":"schema_236"},"schema_237":{"kind":"json-schema","data":{"type":"integer","maximum":100,"minimum":1,"default":30,"title":"Limit"},"id":"schema_237"},"schema_238":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/CreateVirtualBankAccountPortalRequest"},{"$ref":"#/components/schemas/CreateCryptoDepositAddressPortalRequest"}],"title":"Payload"},"id":"schema_238"},"schema_239":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Portal Id"},"id":"schema_239"},"schema_240":{"kind":"json-schema","data":{"type":"integer","exclusiveMinimum":0,"lte":100,"default":30,"title":"Limit"},"id":"schema_240"},"schema_241":{"kind":"json-schema","data":{"enum":["desc","asc"],"type":"string","default":"desc","title":"Order"},"id":"schema_241"},"schema_242":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid"}},{"type":"null"}],"title":"Pocket[]"},"id":"schema_242"},"schema_243":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid"}},{"type":"null"}],"title":"Portal[]"},"id":"schema_243"},"schema_244":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid"}},{"type":"null"}],"title":"Card[]"},"id":"schema_244"},"schema_245":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"enum":["ACH","WIRE","ON_US","CARD","FEE","CREDIT","GENERIC","ON_CHAIN"],"type":"string"}},{"type":"null"}],"title":"Type[]"},"id":"schema_245"},"schema_246":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid"}},{"type":"null"}],"title":"On Us Transfer[]"},"id":"schema_246"},"schema_247":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid"}},{"type":"null"}],"title":"Wire[]"},"id":"schema_247"},"schema_248":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Time Booked From"},"id":"schema_248"},"schema_249":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Time Booked To"},"id":"schema_249"},"schema_250":{"kind":"json-schema","data":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount To"},"id":"schema_250"},"schema_251":{"kind":"json-schema","data":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount From"},"id":"schema_251"},"schema_252":{"kind":"json-schema","data":{"anyOf":[{"enum":["DEBIT","CREDIT"],"type":"string"},{"type":"null"}],"title":"Direction"},"id":"schema_252"},"schema_253":{"kind":"json-schema","data":{"anyOf":[{"enum":["DEPOSIT","REINVESTMENT"],"type":"string"},{"type":"null"}],"title":"Applicable To"},"id":"schema_253"},"schema_254":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Filters the resulting trade list by book date from the provided ISO8601 date, inclusively","title":"Book Date From"},"id":"schema_254"},"schema_255":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Filters the resulting trade list by book date to the provided ISO8601 date, inclusively","title":"Book Date To"},"id":"schema_255"},"schema_256":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Filters the resulting trade list by settlement date from the provided ISO8601 date, inclusively","title":"Settlement Date From"},"id":"schema_256"},"schema_257":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Filters the resulting trade list by settlement date to the provided ISO8601 date, inclusively","title":"Settlement Date To"},"id":"schema_257"},"schema_258":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid"}},{"type":"null"}],"title":"Account[]"},"id":"schema_258"},"schema_259":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Trade Datetime From"},"id":"schema_259"},"schema_260":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Trade Datetime To"},"id":"schema_260"},"schema_261":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Trade Id"},"id":"schema_261"},"schema_262":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Account Id"},"id":"schema_262"},"schema_263":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid"}},{"type":"null"}],"title":"Pocket Id[]"},"id":"schema_263"},"schema_264":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"anyOf":[{"const":"ach","type":"string"},{"const":"wire","type":"string"},{"const":"on_us","type":"string"},{"const":"international_wire","type":"string"},{"const":"crypto_wallet_address","type":"string"}]}},{"type":"null"}],"title":"Type"},"id":"schema_264"},"schema_265":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"enum":["PENDING","FAILED","LINKED","UNLINKED","CLOSED"],"type":"string"}},{"type":"null"}],"title":"Status"},"id":"schema_265"},"schema_266":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/CreateWireCounterpartyRequest"},{"$ref":"#/components/schemas/CreateACHCounterpartyRequest"},{"$ref":"#/components/schemas/CreateOnUsCounterpartyRequest"},{"$ref":"#/components/schemas/CreateInternationalWireCounterpartyRequest"},{"$ref":"#/components/schemas/CreateCryptoWalletAddressCounterpartyRequest"}],"title":"Payload"},"id":"schema_266"},"schema_267":{"kind":"json-schema","data":{},"id":"schema_267"},"schema_268":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Counterparty Id"},"id":"schema_268"},"schema_269":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ACHCounterpartyV2"},{"$ref":"#/components/schemas/WireCounterpartyV2"},{"$ref":"#/components/schemas/OnUsCounterpartyV2"},{"$ref":"#/components/schemas/InternationalWireCounterpartyV2"},{"$ref":"#/components/schemas/CryptoWalletAddressCounterpartyV2"}],"discriminator":{"propertyName":"type","mapping":{"ach":"#/components/schemas/ACHCounterpartyV2","wire":"#/components/schemas/WireCounterpartyV2","on_us":"#/components/schemas/OnUsCounterpartyV2","international_wire":"#/components/schemas/InternationalWireCounterpartyV2","crypto_wallet_address":"#/components/schemas/CryptoWalletAddressCounterpartyV2"}},"title":"Response Get-Counterparty-V2"},"id":"schema_269"},"schema_270":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/TransferRequestStatus"}},{"type":"null"}],"title":"Status Filter[]"},"id":"schema_270"},"schema_271":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid"}},{"type":"null"}],"title":"Reviewer Filter[]"},"id":"schema_271"},"schema_272":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Filter[]"},"id":"schema_272"},"schema_273":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid"}},{"type":"null"}],"title":"Exclude Creator Filter[]"},"id":"schema_273"},"schema_274":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"","title":"Cursor"},"id":"schema_274"},"schema_275":{"kind":"json-schema","data":{"anyOf":[{"type":"integer","exclusiveMinimum":0},{"type":"null"}],"lte":100,"default":30,"title":"Limit"},"id":"schema_275"},"schema_276":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/DualAuthUser"},"type":"array","title":"Response Get Transfer Request Reviewers Api V1 Transfer Requests Reviewers  Get"},"id":"schema_276"},"schema_277":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Transfer Id"},"id":"schema_277"},"schema_278":{"kind":"json-schema","data":{"type":"integer","maximum":100,"exclusiveMinimum":0,"default":30,"title":"Limit"},"id":"schema_278"},"schema_279":{"kind":"json-schema","data":{"anyOf":[{"enum":["INCOMING","OUTGOING"],"type":"string"},{"type":"null"}],"title":"Direction"},"id":"schema_279"},"schema_280":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Wire Id"},"id":"schema_280"},"schema_281":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/IncomingWireResponse"},{"$ref":"#/components/schemas/OutgoingWireResponse"}],"discriminator":{"propertyName":"direction","mapping":{"INCOMING":"#/components/schemas/IncomingWireResponse","OUTGOING":"#/components/schemas/OutgoingWireResponse"}},"title":"Response Get-Wire-V1"},"id":"schema_281"},"schema_282":{"kind":"json-schema","data":{"type":"integer","maximum":100,"minimum":1,"default":100,"title":"Limit"},"id":"schema_282"},"schema_283":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Subscription Id"},"id":"schema_283"},"schema_284":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Subscription Id"},"id":"schema_284"},"schema_285":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"After"},"id":"schema_285"},"schema_286":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/NotificationStatus"},{"type":"null"}],"title":"Status"},"id":"schema_286"},"schema_287":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Notification Id"},"id":"schema_287"},"schema_288":{"kind":"json-schema","data":{"type":"array","items":{"enum":["1099B","1099INT","BANK","BROKERAGE","CONSOLIDATED_BANK","CONSOLIDATED_BROKERAGE"],"type":"string"},"title":"Type[]"},"id":"schema_288"},"schema_289":{"kind":"json-schema","data":{"type":"integer","exclusiveMinimum":0,"lte":150,"default":30,"title":"Limit"},"id":"schema_289"},"schema_290":{"kind":"json-schema","data":{"anyOf":[{"type":"string","pattern":"^\\d{4}(-\\d{2})?$"},{"type":"null"}],"title":"Key"},"id":"schema_290"},"schema_291":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date From"},"id":"schema_291"},"schema_292":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date To"},"id":"schema_292"},"schema_293":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Report Request Id"},"id":"schema_293"},"schema_294":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Report Id"},"id":"schema_294"},"schema_295":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/MembershipInfo"},"type":"array","title":"Response Get-User-Memberships"},"id":"schema_295"},"schema_296":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Member Id"},"id":"schema_296"},"schema_297":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"},"id":"schema_297"},"schema_298":{"kind":"json-schema","data":{"type":"integer","exclusiveMinimum":0,"lte":100,"default":100,"title":"Limit"},"id":"schema_298"},"schema_299":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp From"},"id":"schema_299"},"schema_300":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp To"},"id":"schema_300"},"schema_301":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Member Id"},"id":"schema_301"},"schema_302":{"kind":"json-schema","data":{"enum":["ID_FRONT","ID_BACK","ID_BARCODE","SELFIE","IDENTIFICATION_NUMBER_VERIFICATION","ADDRESS_VERIFICATION","PASSPORT","EIN_CONFIRMATION","OPERATING_AGREEMENT","PARTNERSHIP_AGREEMENT","ARTICLES_OF_INCORPORATION","BYLAWS","PROOF_OF_501_STATUS","ARTICLES_OF_ASSOCIATION","CORPORATE_CHARTER","TRUST_FORMATION_RECORDS","LIST_OF_TRUSTEES","TRUST_VERIFICATION_DOCUMENT","LEGAL_ANALYSIS_OF_BUSINESS_MODEL","COINS_AND_TOKENS_LISTED_AND_OFFERED","COIN_RATING_POLICY_AND_PROCEDURES","TYPE_OF_BLOCKCHAIN_ANALYTICS_USED","MARKET_MANIPULATION_POLICY","BSA_AML_OFAC_POLICIES","INDEPENDENT_AML_AUDIT_REPORT","BSA_AML_OFAC_INTERNAL_RISK_ASSESSMENT","ARTICLES_OF_ORGANIZATION","FLOW_OF_FUNDS","BANK_STATEMENTS_1","BANK_STATEMENTS_2","BANK_STATEMENTS_3","ORG_CHART","BUSINESS_DESCRIPTION","CERTIFICATE_OF_GOOD_STANDING","CERTIFICATE_OF_TRADE_NAME","COMPANY_RESOLUTION","SIGNATURE_AUTHORIZATION","BANK_STATEMENT","BUSINESS_LICENSE","CERTIFICATE_OF_EXISTENCE","CERTIFICATE_OF_ASSUMED_NAME","COMPANY_REGISTRATION_DOCUMENT","INTERNAL_KYC_AUDIT","EXTERNAL_KYC_AUDIT","KYC_POLICIES_AND_PROCEDURES","WIRE_COUNTERPARTY_VERIFICATION","CUSTOMER_RFI_REPLY","OTHER"],"type":"string","title":"Document Type"},"id":"schema_302"},"schema_303":{"kind":"json-schema","data":{"type":"string","pattern":"image/png|application/pdf|image/jpeg","title":"Content-Type"},"id":"schema_303"},"schema_304":{"kind":"json-schema","data":{"type":"integer","exclusiveMaximum":52428800,"exclusiveMinimum":0,"title":"Content-Length"},"id":"schema_304"}},"exampleStore":{"paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_individual_incoming_wire":{"value":{"routing_number":"987654321","identifier":"1234567890","address":{"street_address":"2000 Allston Way","street_address2":"","city":"Berkeley","postal_code":"94701","state":"CA","country":"US"},"wire_instructions":"Example wire instructions","counterparty_name":{"first_name":"External","last_name":"Accountholder","type":"individual"},"verification":{"type":"incoming_wire","wire_id":"e5449f18-2383-4772-8fec-9d90a8cb2542"},"type":"wire"},"key":"dwc_req_individual_incoming_wire","summary":"Domestic wire: individual name, incoming wire verification","id":"paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_individual_incoming_wire"},"paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_business_incoming_wire":{"value":{"routing_number":"987654321","identifier":"1234567890","address":{"street_address":"2000 Allston Way","street_address2":"","city":"Berkeley","postal_code":"94701","state":"CA","country":"US"},"wire_instructions":"Example wire instructions","counterparty_name":{"business_name":"Acme Corporation","type":"business"},"verification":{"type":"incoming_wire","wire_id":"e5449f18-2383-4772-8fec-9d90a8cb2542"},"type":"wire"},"key":"dwc_req_business_incoming_wire","summary":"Domestic wire: business name, incoming wire verification","id":"paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_business_incoming_wire"},"paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_pre_verified":{"value":{"routing_number":"987654321","identifier":"1234567890","address":{"street_address":"2000 Allston Way","street_address2":"","city":"Berkeley","postal_code":"94701","state":"CA","country":"US"},"wire_instructions":"Example wire instructions","counterparty_name":{"first_name":"External","last_name":"Accountholder","type":"individual"},"verification":{"type":"pre_verified","verification_method":"PLAID"},"type":"wire"},"key":"dwc_req_pre_verified","summary":"Domestic wire: individual name, pre-verified verification","id":"paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_pre_verified"},"paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_supporting_docs":{"value":{"routing_number":"987654321","identifier":"1234567890","address":{"street_address":"2000 Allston Way","street_address2":"","city":"Berkeley","postal_code":"94701","state":"CA","country":"US"},"wire_instructions":"Example wire instructions","counterparty_name":{"first_name":"External","last_name":"Accountholder","type":"individual"},"verification":{"type":"supporting_documents","document_ids":["497f6eca-6276-4993-bfeb-53cbbbba6f08"]},"type":"wire"},"key":"dwc_req_supporting_docs","summary":"Domestic wire: individual name, supporting documents verification","id":"paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_supporting_docs"},"paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_unverified":{"value":{"routing_number":"987654321","identifier":"1234567890","address":{"street_address":"2000 Allston Way","street_address2":"","city":"Berkeley","postal_code":"94701","state":"CA","country":"US"},"wire_instructions":"Example wire instructions","counterparty_name":{"first_name":"External","last_name":"Accountholder","type":"individual"},"verification":{"type":"unverified"},"type":"wire"},"key":"dwc_req_unverified","summary":"Domestic wire: individual name, unverified","id":"paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req_unverified"},"paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_biz":{"value":[{"wire_instructions":"Example wire instructions","counterparty_name":{"business_name":"Deutsche Bank AG","type":"business"},"address":{"street_address":"Taunusanlage 12","street_address2":"","city":"Frankfurt am Main","postal_code":"60325","state":"","country":"DE"},"identifier":"DE89370400440532013000","identifier_type":"iban","swift_bic":"DEUTDEFF","verification":{"type":"unverified"},"type":"international_wire"}],"key":"iwc_req_iban_biz","summary":"International wire: business name, IBAN","id":"paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_biz"},"paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_ind":{"value":[{"wire_instructions":"Example wire instructions","counterparty_name":{"first_name":"Hans","last_name":"Mueller","type":"individual"},"address":{"street_address":"Unter den Linden 5","street_address2":"","city":"Berlin","postal_code":"10117","state":"","country":"DE"},"identifier":"DE89370400440532013000","identifier_type":"iban","swift_bic":"DEUTDEFF","verification":{"type":"unverified"},"type":"international_wire"}],"key":"iwc_req_iban_ind","summary":"International wire: individual name, IBAN","id":"paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_ind"},"paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_biz":{"value":[{"wire_instructions":"Example wire instructions","counterparty_name":{"business_name":"Deutsche Bank AG","type":"business"},"address":{"street_address":"Taunusanlage 12","street_address2":"","city":"Frankfurt am Main","postal_code":"60325","state":"","country":"DE"},"identifier":"1234567890","identifier_type":"local","swift_bic":"DEUTDEFF","verification":{"type":"unverified"},"type":"international_wire"}],"key":"iwc_req_local_biz","summary":"International wire: business name, local account number","id":"paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_biz"},"paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_ind":{"value":[{"wire_instructions":"Example wire instructions","counterparty_name":{"first_name":"Hans","last_name":"Mueller","type":"individual"},"address":{"street_address":"Unter den Linden 5","street_address2":"","city":"Berlin","postal_code":"10117","state":"","country":"DE"},"identifier":"1234567890","identifier_type":"local","swift_bic":"DEUTDEFF","verification":{"type":"unverified"},"type":"international_wire"}],"key":"iwc_req_local_ind","summary":"International wire: individual name, local account number","id":"paths/~1api~1v2~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_ind"},"paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/wire_transfer":{"value":{"transfer":{"id":"7fe330b4-1c1c-2261-ab11-2d257e921310","type":"WIRE","origin_pocket_id":"c404fd0f-c0f3-49ff-a9d7-553edda0539c","counterparty_id":"a904fd0f-c0f3-49ff-a9d7-553edda0537a","amount":{"type":"REQUESTED_AMOUNT","amount_usdc":100000},"description":"Monthly payment"},"reviewers":[]},"key":"wire_transfer","summary":"Wire transfer request","id":"paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/wire_transfer"},"paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/on_us_peer_to_peer":{"value":{"transfer":{"id":"7fe330b4-1c1c-2261-ab11-2d257e921310","type":"ON_US","origin_pocket_id":"c404fd0f-c0f3-49ff-a9d7-553edda0539c","amount":{"type":"REQUESTED_AMOUNT","amount_usdc":100},"details":{"type":"PEER_TO_PEER","destination_counterparty_id":"4f12ee51-776a-4134-92c7-c197faca7d73"},"description":"This is a Peer to Peer JikoNet Transfer.","end_to_end_identification":"E2E-ID-12345"},"reviewers":[]},"key":"on_us_peer_to_peer","summary":"On-us peer-to-peer transfer request","id":"paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/on_us_peer_to_peer"},"paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/on_us_internal_reallocation":{"value":{"transfer":{"id":"7fe330b4-1c1c-2261-ab11-2d257e921310","type":"ON_US","origin_pocket_id":"c404fd0f-c0f3-49ff-a9d7-553edda0539c","amount":{"type":"REQUESTED_AMOUNT","amount_usdc":100},"details":{"type":"INTERNAL_REALLOCATION","destination_pocket_id":"c2f00a1b-8bc7-4f69-a867-c3abea101693","transfer_type":"BANK_TRANSFER"},"description":"This is an Internal Reallocation JikoNet Transfer.","end_to_end_identification":"E2E-ID-12345"},"reviewers":[]},"key":"on_us_internal_reallocation","summary":"On-us internal reallocation transfer request","id":"paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/on_us_internal_reallocation"},"paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/usdc_transfer":{"value":{"transfer":{"id":"7fe330b4-1c1c-2261-ab11-2d257e921310","type":"USDC","origin_pocket_id":"c404fd0f-c0f3-49ff-a9d7-553edda0539c","counterparty_id":"a904fd0f-c0f3-49ff-a9d7-553edda0537a","amount":{"type":"REQUESTED_AMOUNT","amount_usdc":100}},"reviewers":[]},"key":"usdc_transfer","summary":"USDC transfer request","id":"paths/~1api~1v1~1transfer-requests~1/post/requestBody/content/application~1json/examples/usdc_transfer"},"paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/bank_statement":{"value":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","report":{"pocket_ids":["497f6eca-6276-4993-bfeb-53cbbbba6f08"],"date":"2019-08-24","type":"BANK_STATEMENT_REPORT"},"output_formats":["CAMT053"]},"key":"bank_statement","summary":"Bank statement report","id":"paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/bank_statement"},"paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/trade_report":{"value":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","report":{"pocket_ids":["497f6eca-6276-4993-bfeb-53cbbbba6f08"],"start_date":"2019-08-24","end_date":"2019-09-24","filter_by_date_type":"trade_date","include_maturity_events":false,"type":"TRADE_REPORT"},"output_formats":["CSV"]},"key":"trade_report","summary":"Trade report","id":"paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/trade_report"},"paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/security_price":{"value":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","report":{"securities":["912797KR1","912797LN9"],"start_date":"2019-08-24","end_date":"2019-09-24","type":"SECURITY_PRICE_REPORT"},"output_formats":["KYRIBA_CSV"]},"key":"security_price","summary":"Security price report","id":"paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/security_price"},"paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/brokerage_statement":{"value":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","report":{"date":"2019-08-24","pocket_ids":["497f6eca-6276-4993-bfeb-53cbbbba6f08"],"type":"BROKERAGE_STATEMENT_REPORT"},"output_formats":["CAMT053"]},"key":"brokerage_statement","summary":"Brokerage statement report","id":"paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/brokerage_statement"},"paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/position_summary":{"value":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","report":{"pocket_ids":["497f6eca-6276-4993-bfeb-53cbbbba6f08"],"date":"2019-08-24","type":"POSITION_SUMMARY_REPORT"},"output_formats":["PDF"]},"key":"position_summary","summary":"Position summary report","id":"paths/~1api~1v1~1report-requests~1/post/requestBody/content/application~1json/examples/position_summary"}},"securitySchemeStore":{"CodeBearer":{"id":"CodeBearer","type":"oauth2","flows":{"authorizationCode":{"scopes":{"openid":"OpenID scope","profile":"Read information for current logged in user","email":"Read email for current logged in user","phone":"Read phone number for current logged in user","pockets.read":"Read pocket information for given customer","pockets.write":"Manage pocket information for given customer","transfers.read":"Read transfer and transfers request information for given customer","transfers.write":"Manage transfer requests","customer.read":"Read customer info for given customer","customer.write":"Write customer info","team.read":"Read team information for given customer","team.write":"Manage teams and team members for given customer","onboarding.read":"Read onboarding information for given customer","onboarding.write":"Manage onboarding information for given customer","agreements.read":"Read agreement information for given customer","subscriptions.write":"Manage customer webhook subscriptions","subscriptions.read":"Read webhook subscription information","approval_rules.read":"Read approval rules","approval_rules.write":"Manage approval rules","authorization_requests.read":"Read authorization requests","authorization_requests.write":"Manage authorization requests"},"authorizationUrl":"https://auth.jiko.io/api/oauth2/authorize","tokenUrl":"https://auth.jiko.io/api/oauth2/token"}}}},"servers":[{"url":"https://api.business.jiko.io","description":"Production server"},{"url":"https://customer-api.sandbox-api.jikoservices.com","description":"Sandbox server"}]},"options":{"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/products/customer-api/reference.json?download"},{"url":"/_bundle/products/customer-api/reference.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Jiko Customer API","description":"## Introduction\n\nWelcome to the Jiko Customer API Reference! Jiko enables you to integrate money storage and movement, backed by the safety and security of US Treasury Bills. Use the Customer API if you are a Jiko customer integrating Jiko directly into your internal systems.\n\n**For questions regarding authorization for the Customer API, please visit [our OAuth guide](/products/customer-api/guides/oauth/getting-started)**\n"}},"baseSlug":"/products/customer-api/reference","routesMapping":{}}