{ "openapi": "3.1.1", "info": { "title": "KycApi.PublicApi | v1", "version": "1.0.0" }, "servers": [ { "url": "https://api.seenpact.com/" } ], "paths": { "/admin/admins": { "get": { "tags": [ "AdminAdmins" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminItem" } } } } } } }, "post": { "tags": [ "AdminAdmins" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AdminCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/admin/admins/{adminId}": { "put": { "tags": [ "AdminAdmins" ], "parameters": [ { "name": "adminId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AdminUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AdminItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AdminItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminItem" } } } } } } }, "/admin/alert-rules": { "get": { "tags": [ "AdminAlerts" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfAlertRuleItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfAlertRuleItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfAlertRuleItem" } } } } } }, "post": { "tags": [ "AdminAlerts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlertRuleCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AlertRuleCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/admin/alert-rules/{ruleId}": { "put": { "tags": [ "AdminAlerts" ], "parameters": [ { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlertRuleUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AlertRuleUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AlertRuleItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlertRuleItem" } } } } } }, "delete": { "tags": [ "AdminAlerts" ], "parameters": [ { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/admin/alert-events": { "get": { "tags": [ "AdminAlerts" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfAlertEventItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfAlertEventItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfAlertEventItem" } } } } } } }, "/admin/alert-events/{eventId}/ack": { "post": { "tags": [ "AdminAlerts" ], "parameters": [ { "name": "eventId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AlertEventItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlertEventItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlertEventItem" } } } } } } }, "/admin/dashboard/timeseries": { "get": { "tags": [ "AdminAnalytics" ], "parameters": [ { "name": "metric", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "bucket", "in": "query", "schema": { "type": "string", "default": "hour" } }, { "name": "company_id", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TimeseriesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TimeseriesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TimeseriesResponse" } } } } } } }, "/admin/dashboard/breakdown": { "get": { "tags": [ "AdminAnalytics" ], "parameters": [ { "name": "dim", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "company_id", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BreakdownResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BreakdownResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BreakdownResponse" } } } } } } }, "/admin/dashboard/funnel": { "get": { "tags": [ "AdminAnalytics" ], "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "company_id", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FunnelResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FunnelResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FunnelResponse" } } } } } } }, "/admin/analytics/errors": { "get": { "tags": [ "AdminAnalytics" ], "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "company_id", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorsAnalyticsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorsAnalyticsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorsAnalyticsResponse" } } } } } } }, "/admin/analytics/retries": { "get": { "tags": [ "AdminAnalytics" ], "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "company_id", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RetriesAnalyticsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RetriesAnalyticsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetriesAnalyticsResponse" } } } } } } }, "/admin/analytics/durations": { "get": { "tags": [ "AdminAnalytics" ], "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DurationsAnalyticsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DurationsAnalyticsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DurationsAnalyticsResponse" } } } } } } }, "/admin/dashboard/system-health": { "get": { "tags": [ "AdminAnalytics" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SystemHealthResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SystemHealthResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SystemHealthResponse" } } } } } } }, "/admin/auth/login": { "post": { "tags": [ "AdminAuth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminLoginCommand" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminLoginCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AdminLoginCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/admin/auth/refresh": { "post": { "tags": [ "AdminAuth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminRefreshCommand" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminRefreshCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AdminRefreshCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/admin/auth/logout": { "post": { "tags": [ "AdminAuth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminLogoutCommand" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminLogoutCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AdminLogoutCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/admin/auth/me": { "get": { "tags": [ "AdminAuth" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AdminProfileResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AdminProfileResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminProfileResponse" } } } } } } }, "/admin/auth/2fa/setup": { "post": { "tags": [ "AdminAuth" ], "responses": { "200": { "description": "OK" } } } }, "/admin/auth/2fa/enable": { "post": { "tags": [ "AdminAuth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TotpCodeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TotpCodeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TotpCodeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/admin/auth/2fa/disable": { "post": { "tags": [ "AdminAuth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TotpCodeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TotpCodeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TotpCodeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/admin/companies": { "post": { "tags": [ "AdminBilling" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CompanyCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "AdminBilling" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfCompanyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfCompanyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfCompanyResponse" } } } } } } }, "/admin/companies/{companyId}": { "get": { "tags": [ "AdminBilling" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CompanyDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyDetailResponse" } } } } } }, "put": { "tags": [ "AdminBilling" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CompanyUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } } } } } } }, "/admin/wallets": { "get": { "tags": [ "AdminBilling" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfAdminWalletItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfAdminWalletItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfAdminWalletItem" } } } } } } }, "/admin/companies/{companyId}/wallet/transactions": { "get": { "tags": [ "AdminBilling" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfCreditTransactionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfCreditTransactionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfCreditTransactionResponse" } } } } } } }, "/admin/companies/{companyId}/wallet/adjust": { "post": { "tags": [ "AdminBilling" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletAdjustRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WalletAdjustRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WalletAdjustRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/admin/invoices": { "get": { "tags": [ "AdminBilling" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfInvoiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfInvoiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfInvoiceResponse" } } } } } } }, "/admin/companies/{companyId}/invoices": { "get": { "tags": [ "AdminBilling" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfInvoiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfInvoiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfInvoiceResponse" } } } } } }, "post": { "tags": [ "AdminBilling" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InvoiceCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InvoiceCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/admin/invoices/{invoiceId}": { "get": { "tags": [ "AdminBilling" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InvoiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InvoiceResponse" } } } } } } }, "/admin/invoices/{invoiceId}/file": { "get": { "tags": [ "AdminBilling" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/admin/invoices/{invoiceId}/manual-receipt": { "post": { "tags": [ "AdminBilling" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManualReceiptRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ManualReceiptRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ManualReceiptRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/admin/invoices/{invoiceId}/cancel": { "post": { "tags": [ "AdminBilling" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InvoiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InvoiceResponse" } } } } } } }, "/admin/extra-kyc-requests": { "get": { "tags": [ "AdminBilling" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } }, { "name": "company_id", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfExtraKycRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfExtraKycRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfExtraKycRequestResponse" } } } } } } }, "/admin/extra-kyc-requests/{requestId}/approve": { "post": { "tags": [ "AdminBilling" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtraKycApproveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExtraKycApproveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExtraKycApproveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/admin/extra-kyc-requests/{requestId}/reject": { "post": { "tags": [ "AdminBilling" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtraKycRejectRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExtraKycRejectRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExtraKycRejectRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/admin/certificates/{certificateId}/revoke": { "post": { "tags": [ "AdminCertificates" ], "parameters": [ { "name": "certificateId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeCertificateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RevokeCertificateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RevokeCertificateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertificateHistoryItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertificateHistoryItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertificateHistoryItem" } } } } } } }, "/admin/certificates/{certificateId}/unlock": { "post": { "tags": [ "AdminCertificates" ], "parameters": [ { "name": "certificateId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertificateHistoryItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertificateHistoryItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertificateHistoryItem" } } } } } } }, "/admin/certificate-revocation-requests": { "get": { "tags": [ "AdminCertificates" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } }, { "name": "status", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfCertificateRevocationRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfCertificateRevocationRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfCertificateRevocationRequestResponse" } } } } } } }, "/admin/certificate-revocation-requests/{requestId}/approve": { "post": { "tags": [ "AdminCertificates" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertificateRevocationRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertificateRevocationRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertificateRevocationRequestResponse" } } } } } } }, "/admin/certificate-revocation-requests/{requestId}/reject": { "post": { "tags": [ "AdminCertificates" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevocationRejectRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RevocationRejectRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RevocationRejectRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertificateRevocationRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertificateRevocationRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertificateRevocationRequestResponse" } } } } } } }, "/admin/compliance/pii-access-logs": { "get": { "tags": [ "AdminCompliance" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfPiiAccessLogItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfPiiAccessLogItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfPiiAccessLogItem" } } } } } } }, "/admin/compliance/end-users/{endUserId}/export": { "get": { "tags": [ "AdminCompliance" ], "parameters": [ { "name": "endUserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EndUserExportResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EndUserExportResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndUserExportResponse" } } } } } } }, "/admin/compliance/retention-status": { "get": { "tags": [ "AdminCompliance" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RetentionStatusItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RetentionStatusItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RetentionStatusItem" } } } } } } } }, "/admin/contact-messages": { "get": { "tags": [ "AdminContactMessages" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QueryPageOfContactMessageItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QueryPageOfContactMessageItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QueryPageOfContactMessageItem" } } } } } } }, "/admin/contact-messages/{id}": { "get": { "tags": [ "AdminContactMessages" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContactMessageItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContactMessageItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactMessageItem" } } } } } } }, "/admin/contact-messages/{id}/status": { "post": { "tags": [ "AdminContactMessages" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StatusRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContactMessageItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContactMessageItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactMessageItem" } } } } } } }, "/admin/control/switches": { "get": { "tags": [ "AdminControl" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlatformSwitches" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlatformSwitches" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlatformSwitches" } } } } } }, "put": { "tags": [ "AdminControl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwitchesUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SwitchesUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SwitchesUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlatformSwitches" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlatformSwitches" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlatformSwitches" } } } } } } }, "/admin/companies/{companyId}/overrides": { "get": { "tags": [ "AdminCompanyOverrides" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CompanyOverridesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompanyOverridesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyOverridesResponse" } } } } } }, "put": { "tags": [ "AdminCompanyOverrides" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OverridesUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OverridesUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OverridesUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CompanyOverridesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompanyOverridesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyOverridesResponse" } } } } } } }, "/admin/blocklist": { "get": { "tags": [ "AdminBlocklist" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfBlocklistEntryItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfBlocklistEntryItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfBlocklistEntryItem" } } } } } }, "post": { "tags": [ "AdminBlocklist" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlocklistCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BlocklistCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BlocklistCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/admin/blocklist/{entryId}": { "delete": { "tags": [ "AdminBlocklist" ], "parameters": [ { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/admin/risk-signals": { "get": { "tags": [ "AdminBlocklist" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskSignalsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskSignalsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskSignalsResponse" } } } } } } }, "/admin/logs/external-calls": { "get": { "tags": [ "AdminLogs" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QueryPageOfExternalCallLogItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QueryPageOfExternalCallLogItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QueryPageOfExternalCallLogItem" } } } } } } }, "/admin/logs/email-outbox": { "get": { "tags": [ "AdminLogs" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QueryPageOfEmailOutboxItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QueryPageOfEmailOutboxItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QueryPageOfEmailOutboxItem" } } } } } } }, "/admin/logs/email-outbox/{id}/retry": { "post": { "tags": [ "AdminLogs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EmailOutboxItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EmailOutboxItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EmailOutboxItem" } } } } } } }, "/admin/logs/webhook-deliveries": { "get": { "tags": [ "AdminLogs" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QueryPageOfWebhookDeliveryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QueryPageOfWebhookDeliveryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QueryPageOfWebhookDeliveryResponse" } } } } } } }, "/admin/logs/webhook-deliveries/{id}/redeliver": { "post": { "tags": [ "AdminLogs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookDeliveryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDeliveryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookDeliveryResponse" } } } } } } }, "/admin/monitoring/kyc-requests/{requestId}": { "get": { "tags": [ "AdminMonitoring" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "reveal", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/KycRequestComplianceDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KycRequestComplianceDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KycRequestComplianceDetailResponse" } } } } } } }, "/admin/dashboard/stats": { "get": { "tags": [ "AdminMonitoring" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DashboardStatsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DashboardStatsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DashboardStatsResponse" } } } } } } }, "/admin/monitoring/kyc-requests": { "get": { "tags": [ "AdminMonitoring" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfMonitorKycRequestItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfMonitorKycRequestItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfMonitorKycRequestItem" } } } } } } }, "/admin/monitoring/sign-requests": { "get": { "tags": [ "AdminMonitoring" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfMonitorSignRequestItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfMonitorSignRequestItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfMonitorSignRequestItem" } } } } } } }, "/admin/monitoring/certificates": { "get": { "tags": [ "AdminMonitoring" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfMonitorCertificateItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfMonitorCertificateItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfMonitorCertificateItem" } } } } } } }, "/admin/monitoring/api-request-logs": { "get": { "tags": [ "AdminMonitoring" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QueryPageOfApiRequestLogItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QueryPageOfApiRequestLogItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QueryPageOfApiRequestLogItem" } } } } } } }, "/admin/audit-logs": { "get": { "tags": [ "AdminMonitoring" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfAuditLogItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfAuditLogItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfAuditLogItem" } } } } } } }, "/company/docs": { "get": { "tags": [ "CompanyDocs" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocsInfoResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocsInfoResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocsInfoResponse" } } } } } } }, "/admin/ops/stuck-requests": { "get": { "tags": [ "AdminOps" ], "parameters": [ { "name": "older_than_minutes", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 15 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StuckSubmissionItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StuckSubmissionItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StuckSubmissionItem" } } } } } } } }, "/admin/ops/stuck-requests/{submissionType}/{submissionId}/requeue": { "post": { "tags": [ "AdminOps" ], "parameters": [ { "name": "submissionType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "submissionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/admin/ops/manual-review": { "get": { "tags": [ "AdminOps" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StuckSubmissionItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StuckSubmissionItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StuckSubmissionItem" } } } } } } } }, "/admin/ops/manual-review/{submissionType}/{submissionId}/resolve": { "post": { "tags": [ "AdminOps" ], "parameters": [ { "name": "submissionType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "submissionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResolveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResolveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/admin/ops/dead-letters": { "get": { "tags": [ "AdminOps" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeadLetterItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeadLetterItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeadLetterItem" } } } } } } } }, "/admin/ops/dead-letters/emails/{id}/retry": { "post": { "tags": [ "AdminOps" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EmailOutboxItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EmailOutboxItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EmailOutboxItem" } } } } } } }, "/admin/ops/dead-letters/webhooks/{id}/retry": { "post": { "tags": [ "AdminOps" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookDeliveryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDeliveryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookDeliveryResponse" } } } } } } }, "/admin/ops/reservations": { "get": { "tags": [ "AdminOps" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HeldReservationItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HeldReservationItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HeldReservationItem" } } } } } } } }, "/admin/ops/reservations/release": { "post": { "tags": [ "AdminOps" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReleaseRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReleaseReservationsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseReservationsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseReservationsResponse" } } } } } } }, "/admin/recycle-bin/entities": { "get": { "tags": [ "AdminRecycleBin" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/admin/recycle-bin/{entity}": { "get": { "tags": [ "AdminRecycleBin" ], "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfSoftDeletedItemDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfSoftDeletedItemDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfSoftDeletedItemDto" } } } } } } }, "/admin/recycle-bin/{entity}/{id}/delete": { "post": { "tags": [ "AdminRecycleBin" ], "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/admin/recycle-bin/{entity}/{id}/restore": { "post": { "tags": [ "AdminRecycleBin" ], "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/certificates/{endUserId}/otp/request": { "post": { "tags": [ "Certificates" ], "parameters": [ { "name": "endUserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/certificates/{endUserId}/otp/resend": { "post": { "tags": [ "Certificates" ], "parameters": [ { "name": "endUserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/certificates/{endUserId}": { "post": { "tags": [ "Certificates" ], "parameters": [ { "name": "endUserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertificateIssueRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertificateIssueRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CertificateIssueRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Certificates" ], "parameters": [ { "name": "endUserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EndUserCertificatesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EndUserCertificatesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndUserCertificatesResponse" } } } } } } }, "/v1/certificates/{endUserId}/pin/reset/request": { "post": { "tags": [ "Certificates" ], "parameters": [ { "name": "endUserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/certificates/{endUserId}/pin/reset/confirm": { "post": { "tags": [ "Certificates" ], "parameters": [ { "name": "endUserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PinResetConfirmRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PinResetConfirmRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PinResetConfirmRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/company/certificates": { "get": { "tags": [ "CompanyCertificatesMonitor" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfCertificateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfCertificateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfCertificateResponse" } } } } } } }, "/company/certificates/{certificateId}/pin-reset-email": { "post": { "tags": [ "CompanyCertificatesMonitor" ], "parameters": [ { "name": "certificateId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/company/certificates/{certificateId}/revocation-request": { "post": { "tags": [ "CompanyCertificatesMonitor" ], "parameters": [ { "name": "certificateId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevocationRequestCreate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RevocationRequestCreate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RevocationRequestCreate" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/company/certificate-revocation-requests": { "get": { "tags": [ "CompanyRevocationRequests" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } }, { "name": "status", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfCertificateRevocationRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfCertificateRevocationRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfCertificateRevocationRequestResponse" } } } } } } }, "/company/dashboard/stats": { "get": { "tags": [ "CompanyAnalytics" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CompanyDashboardStatsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDashboardStatsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyDashboardStatsResponse" } } } } } } }, "/company/dashboard/timeseries": { "get": { "tags": [ "CompanyAnalytics" ], "parameters": [ { "name": "metric", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "bucket", "in": "query", "schema": { "type": "string", "default": "hour" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TimeseriesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TimeseriesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TimeseriesResponse" } } } } } } }, "/company/dashboard/breakdown": { "get": { "tags": [ "CompanyAnalytics" ], "parameters": [ { "name": "dim", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BreakdownResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BreakdownResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BreakdownResponse" } } } } } } }, "/company/dashboard/funnel": { "get": { "tags": [ "CompanyAnalytics" ], "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FunnelResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FunnelResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FunnelResponse" } } } } } } }, "/company/analytics/errors": { "get": { "tags": [ "CompanyAnalytics" ], "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorsAnalyticsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorsAnalyticsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorsAnalyticsResponse" } } } } } } }, "/company/analytics/retries": { "get": { "tags": [ "CompanyAnalytics" ], "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RetriesAnalyticsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RetriesAnalyticsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetriesAnalyticsResponse" } } } } } } }, "/company/logs/api-requests": { "get": { "tags": [ "CompanyLogs" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QueryPageOfApiRequestLogItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QueryPageOfApiRequestLogItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QueryPageOfApiRequestLogItem" } } } } } } }, "/company/api-keys": { "post": { "tags": [ "CompanyApiKeys" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "CompanyApiKeys" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeyResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeyResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeyResponse" } } } } } } } }, "/company/api-keys/{keyId}": { "put": { "tags": [ "CompanyApiKeys" ], "parameters": [ { "name": "keyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateApiKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateApiKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateApiKeyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiKeyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiKeyResponse" } } } } } }, "delete": { "tags": [ "CompanyApiKeys" ], "parameters": [ { "name": "keyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/company/auth/login": { "post": { "tags": [ "CompanyAuth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyLoginCommand" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyLoginCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CompanyLoginCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/company/auth/refresh": { "post": { "tags": [ "CompanyAuth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyRefreshCommand" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyRefreshCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CompanyRefreshCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/company/auth/logout": { "post": { "tags": [ "CompanyAuth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyLogoutCommand" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyLogoutCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CompanyLogoutCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/company/auth/me": { "get": { "tags": [ "CompanyAuth" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CompanyProfileResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompanyProfileResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyProfileResponse" } } } } } } }, "/company/extra-kyc-requests": { "post": { "tags": [ "CompanyExtraKyc" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtraKycRequestCreate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExtraKycRequestCreate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExtraKycRequestCreate" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "CompanyExtraKyc" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } }, { "name": "status", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfExtraKycRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfExtraKycRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfExtraKycRequestResponse" } } } } } } }, "/company/wallet": { "get": { "tags": [ "CompanyWallet" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CompanyWalletResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompanyWalletResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyWalletResponse" } } } } } } }, "/company/wallet/transactions": { "get": { "tags": [ "CompanyWallet" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfCreditTransactionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfCreditTransactionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfCreditTransactionResponse" } } } } } } }, "/company/invoices": { "get": { "tags": [ "CompanyInvoices" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfInvoiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfInvoiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfInvoiceResponse" } } } } } } }, "/company/invoices/{invoiceId}": { "get": { "tags": [ "CompanyInvoices" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InvoiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InvoiceResponse" } } } } } } }, "/company/invoices/{invoiceId}/file": { "get": { "tags": [ "CompanyInvoices" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/company/kyc-requests/{requestId}": { "get": { "tags": [ "CompanyKycMonitor" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "reveal", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/KycRequestComplianceDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KycRequestComplianceDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KycRequestComplianceDetailResponse" } } } } } } }, "/company/kyc-end-users": { "get": { "tags": [ "CompanyKycMonitor" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfKycEndUserResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfKycEndUserResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfKycEndUserResponse" } } } } } } }, "/company/kyc-requests": { "get": { "tags": [ "CompanyKycMonitor" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfKycRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfKycRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfKycRequestResponse" } } } } } } }, "/company/profile": { "put": { "tags": [ "CompanyProfile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCompanyProfileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCompanyProfileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCompanyProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CompanyProfileDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompanyProfileDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyProfileDetailResponse" } } } } } } }, "/company/password": { "put": { "tags": [ "CompanyProfile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeCompanyPasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeCompanyPasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeCompanyPasswordRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/company/webhooks": { "get": { "tags": [ "CompanyWebhooks" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfWebhookEndpointResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfWebhookEndpointResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfWebhookEndpointResponse" } } } } } }, "post": { "tags": [ "CompanyWebhooks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/company/webhooks/{id}": { "put": { "tags": [ "CompanyWebhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookEndpointResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointResponse" } } } } } }, "delete": { "tags": [ "CompanyWebhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/company/webhooks/{id}/test": { "post": { "tags": [ "CompanyWebhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/company/webhooks/{id}/rotate-secret": { "post": { "tags": [ "CompanyWebhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookEndpointCreatedResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointCreatedResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointCreatedResponse" } } } } } } }, "/company/logs/webhook-deliveries": { "get": { "tags": [ "CompanyWebhookDeliveries" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QueryPageOfWebhookDeliveryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QueryPageOfWebhookDeliveryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QueryPageOfWebhookDeliveryResponse" } } } } } } }, "/company/logs/webhook-deliveries/{id}/redeliver": { "post": { "tags": [ "CompanyWebhookDeliveries" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookDeliveryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDeliveryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookDeliveryResponse" } } } } } } }, "/v1/end-users/lookup": { "get": { "tags": [ "EndUsers" ], "parameters": [ { "name": "email", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EndUserLookupResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EndUserLookupResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndUserLookupResponse" } } } } } } }, "/v1/end-users/{endUserId}": { "get": { "tags": [ "EndUsers" ], "parameters": [ { "name": "endUserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/KycEndUserResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KycEndUserResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KycEndUserResponse" } } } } } } }, "/v1/kyc-requests": { "post": { "tags": [ "Kyc" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycRequestCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KycRequestCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KycRequestCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Kyc" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfKycRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfKycRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfKycRequestResponse" } } } } } } }, "/v1/kyc-requests/{requestId}": { "get": { "tags": [ "Kyc" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/KycRequestDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KycRequestDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KycRequestDetailResponse" } } } } } } }, "/v1/kyc-requests/{requestId}/otp/resend": { "post": { "tags": [ "Kyc" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/kyc-requests/{requestId}/otp/verify": { "post": { "tags": [ "Kyc" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OtpVerifyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OtpVerifyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OtpVerifyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/v1/kyc-requests/{requestId}/document": { "post": { "tags": [ "Kyc" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentInfoSubmitRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentInfoSubmitRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentInfoSubmitRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/v1/kyc-requests/{requestId}/document-photo/upload": { "post": { "tags": [ "Kyc" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/v1/kyc-requests/{requestId}/selfie": { "post": { "tags": [ "Kyc" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelfieSubmitRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SelfieSubmitRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SelfieSubmitRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/v1/kyc-requests/{requestId}/selfie/upload": { "post": { "tags": [ "Kyc" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/v1/kyc-requests/{requestId}/selfie/test-pass": { "post": { "tags": [ "Kyc" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/kyc-requests/{requestId}/video/challenge": { "post": { "tags": [ "Kyc" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/kyc-requests/{requestId}/video": { "post": { "tags": [ "Kyc" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoSubmitRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VideoSubmitRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VideoSubmitRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/v1/kyc-requests/{requestId}/video/upload": { "post": { "tags": [ "Kyc" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "allOf": [ { "type": "object", "properties": { "file": { "$ref": "#/components/schemas/IFormFile" } } }, { "type": "object", "properties": { "challenge_code": { "type": "string" } } }, { "type": "object", "properties": { "duration_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } } ] } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/v1/kyc-requests/{requestId}/abandon": { "post": { "tags": [ "Kyc" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/KycRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KycRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KycRequestResponse" } } } } } } }, "/v1/kyc-requests/{requestId}/video/test-pass": { "post": { "tags": [ "Kyc" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/media/{storageKey}": { "get": { "tags": [ "Media" ], "parameters": [ { "name": "storageKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "expires", "in": "query", "schema": { "type": "string" } }, { "name": "signature", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/webhooks/payments/{provider}": { "post": { "tags": [ "PaymentWebhook" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/public/contact": { "post": { "tags": [ "PublicContact" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ContactRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContactAccepted" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContactAccepted" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactAccepted" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/admin/reports": { "get": { "tags": [ "AdminReports" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportDefinitionItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportDefinitionItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportDefinitionItem" } } } } } } }, "post": { "tags": [ "AdminReports" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportDefinitionCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportDefinitionCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportDefinitionCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/admin/reports/{reportId}": { "put": { "tags": [ "AdminReports" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportDefinitionUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportDefinitionUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportDefinitionUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReportDefinitionItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportDefinitionItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportDefinitionItem" } } } } } }, "delete": { "tags": [ "AdminReports" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/admin/reports/{reportId}/run": { "post": { "tags": [ "AdminReports" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/admin/report-runs": { "get": { "tags": [ "AdminReports" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfReportRunItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfReportRunItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfReportRunItem" } } } } } } }, "/admin/report-runs/{runId}/download": { "get": { "tags": [ "AdminReports" ], "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReportDownloadResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportDownloadResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportDownloadResponse" } } } } } } }, "/company/reports": { "get": { "tags": [ "CompanyReports" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportDefinitionItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportDefinitionItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportDefinitionItem" } } } } } } }, "post": { "tags": [ "CompanyReports" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportDefinitionCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportDefinitionCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportDefinitionCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/company/reports/{reportId}": { "put": { "tags": [ "CompanyReports" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportDefinitionUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportDefinitionUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportDefinitionUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReportDefinitionItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportDefinitionItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportDefinitionItem" } } } } } }, "delete": { "tags": [ "CompanyReports" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/company/reports/{reportId}/run": { "post": { "tags": [ "CompanyReports" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/company/report-runs": { "get": { "tags": [ "CompanyReports" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfReportRunItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfReportRunItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfReportRunItem" } } } } } } }, "/company/report-runs/{runId}/download": { "get": { "tags": [ "CompanyReports" ], "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReportDownloadResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportDownloadResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportDownloadResponse" } } } } } } }, "/v1/sign/{token}": { "get": { "tags": [ "Signer" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SignerStatusResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SignerStatusResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SignerStatusResponse" } } } } } } }, "/v1/sign/{token}/kyc/start": { "post": { "tags": [ "Signer" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/KycStartRequest" } ] } }, "text/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/KycStartRequest" } ] } }, "application/*+json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/KycStartRequest" } ] } } } }, "responses": { "200": { "description": "OK" } } } }, "/v1/sign/{token}/kyc/otp/verify": { "post": { "tags": [ "Signer" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycOtpVerifyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KycOtpVerifyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KycOtpVerifyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/v1/sign/{token}/kyc/otp/resend": { "post": { "tags": [ "Signer" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/sign/{token}/kyc/document": { "post": { "tags": [ "Signer" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentInfoSubmitRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentInfoSubmitRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentInfoSubmitRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/v1/sign/{token}/kyc/selfie/upload": { "post": { "tags": [ "Signer" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/v1/sign/{token}/kyc/document-photo/upload": { "post": { "tags": [ "Signer" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/v1/sign/{token}/kyc/video/challenge": { "post": { "tags": [ "Signer" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/sign/{token}/kyc/video/upload": { "post": { "tags": [ "Signer" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "allOf": [ { "type": "object", "properties": { "file": { "$ref": "#/components/schemas/IFormFile" } } }, { "type": "object", "properties": { "challenge_code": { "type": "string" } } }, { "type": "object", "properties": { "duration_seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } } ] } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/v1/sign/{token}/certificate/otp/request": { "post": { "tags": [ "Signer" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/sign/{token}/certificate/otp/resend": { "post": { "tags": [ "Signer" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/sign/{token}/certificate": { "post": { "tags": [ "Signer" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignCertificateIssueRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SignCertificateIssueRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SignCertificateIssueRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/v1/sign/{token}/otp/request": { "post": { "tags": [ "Signer" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/sign/{token}/complete": { "post": { "tags": [ "Signer" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "allOf": [ { "type": "object", "properties": { "signature_image": { "$ref": "#/components/schemas/IFormFile" } } }, { "type": "object", "properties": { "otp_code": { "type": "string" } } }, { "type": "object", "properties": { "pin": { "type": "string" } } }, { "type": "object", "properties": { "x": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, { "type": "object", "properties": { "y": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, { "type": "object", "properties": { "width": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, { "type": "object", "properties": { "height": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, { "type": "object", "properties": { "page_number": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, { "type": "object", "properties": { "repeat_all_pages": { "type": "boolean" } } } ] } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/v1/sign/{token}/document": { "get": { "tags": [ "Signer" ], "parameters": [ { "name": "version", "in": "query", "schema": { "type": "string" } }, { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/sign-documents": { "post": { "tags": [ "SignDocuments" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/v1/sign-requests": { "post": { "tags": [ "SignRequests" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSignRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSignRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateSignRequestBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "SignRequests" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfSignRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfSignRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfSignRequestResponse" } } } } } } }, "/v1/sign-requests/{requestId}": { "get": { "tags": [ "SignRequests" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SignRequestDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SignRequestDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SignRequestDetailResponse" } } } } } } }, "/v1/sign-requests/{requestId}/cancel": { "post": { "tags": [ "SignRequests" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SignRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SignRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SignRequestResponse" } } } } } } }, "/v1/sign-requests/{requestId}/document": { "get": { "tags": [ "SignRequests" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/company/sign-requests": { "get": { "tags": [ "CompanySigningMonitor" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfSignRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfSignRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponseOfSignRequestResponse" } } } } } } }, "/company/sign-requests/{requestId}": { "get": { "tags": [ "CompanySigningMonitor" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SignRequestDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SignRequestDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SignRequestDetailResponse" } } } } } } }, "/company/sign-requests/{requestId}/cancel": { "post": { "tags": [ "CompanySigningMonitor" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SignRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SignRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SignRequestResponse" } } } } } } }, "/company/sign-requests/{requestId}/document": { "get": { "tags": [ "CompanySigningMonitor" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "AdminCreateRequest": { "required": [ "email", "password", "fullName", "role" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" }, "fullName": { "type": "string" }, "role": { "$ref": "#/components/schemas/AdminRole" } } }, "AdminItem": { "required": [ "id", "email", "fullName", "role", "isActive", "totpEnabled", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "fullName": { "type": "string" }, "role": { "$ref": "#/components/schemas/AdminRole" }, "isActive": { "type": "boolean" }, "totpEnabled": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" } } }, "AdminLoginCommand": { "required": [ "email", "password" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" }, "totpCode": { "type": [ "null", "string" ] } } }, "AdminLogoutCommand": { "required": [ "refreshToken" ], "type": "object", "properties": { "refreshToken": { "type": "string" } } }, "AdminProfileResponse": { "required": [ "id", "email", "fullName", "role", "totpEnabled" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "fullName": { "type": "string" }, "role": { "$ref": "#/components/schemas/AdminRole" }, "totpEnabled": { "type": "boolean" } } }, "AdminRefreshCommand": { "required": [ "refreshToken" ], "type": "object", "properties": { "refreshToken": { "type": "string" } } }, "AdminRole": { "type": "integer" }, "AdminUpdateRequest": { "required": [ "fullName", "role", "isActive" ], "type": "object", "properties": { "fullName": { "type": [ "null", "string" ] }, "role": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AdminRole" } ] }, "isActive": { "type": [ "null", "boolean" ] } } }, "AdminWalletItem": { "required": [ "companyId", "companyName", "balance", "reserved", "available", "updatedAt" ], "type": "object", "properties": { "companyId": { "type": "string", "format": "uuid" }, "companyName": { "type": "string" }, "balance": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "reserved": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "available": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "AlertEventItem": { "required": [ "id", "ruleId", "ruleName", "observedValue", "firedAt", "acknowledgedByAdminId", "acknowledgedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "ruleId": { "type": "string", "format": "uuid" }, "ruleName": { "type": [ "null", "string" ] }, "observedValue": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "firedAt": { "type": "string", "format": "date-time" }, "acknowledgedByAdminId": { "type": [ "null", "string" ], "format": "uuid" }, "acknowledgedAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "AlertRuleCreateRequest": { "required": [ "name", "metric", "operator", "threshold", "windowMinutes" ], "type": "object", "properties": { "name": { "type": "string" }, "metric": { "type": "string" }, "operator": { "type": "string" }, "threshold": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "windowMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "AlertRuleItem": { "required": [ "id", "name", "metric", "operator", "threshold", "windowMinutes", "isActive", "lastFiredAt", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "metric": { "type": "string" }, "operator": { "type": "string" }, "threshold": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "windowMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isActive": { "type": "boolean" }, "lastFiredAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" } } }, "AlertRuleUpdateRequest": { "required": [ "name", "metric", "operator", "threshold", "windowMinutes", "isActive" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "metric": { "type": [ "null", "string" ] }, "operator": { "type": [ "null", "string" ] }, "threshold": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "windowMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "isActive": { "type": [ "null", "boolean" ] } } }, "ApiKeyResponse": { "required": [ "id", "keyPrefix", "label", "allowedIps", "isTest", "entityId", "status", "lastUsedAt", "expiresAt", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "keyPrefix": { "type": "string" }, "label": { "type": [ "null", "string" ] }, "allowedIps": { "type": "array", "items": { "type": "string" } }, "isTest": { "type": "boolean" }, "entityId": { "type": [ "null", "string" ], "format": "uuid" }, "status": { "type": "string" }, "lastUsedAt": { "type": [ "null", "string" ], "format": "date-time" }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" } } }, "ApiLogLevel": { "type": "integer" }, "ApiRequestLogItem": { "required": [ "id", "companyId", "method", "path", "statusCode", "durationMs", "level", "errorCode", "traceId", "ipAddress", "userAgent", "apiKeyPrefix", "isTest", "requestBody", "responseBody", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "companyId": { "type": [ "null", "string" ], "format": "uuid" }, "method": { "type": "string" }, "path": { "type": "string" }, "statusCode": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "durationMs": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "level": { "$ref": "#/components/schemas/ApiLogLevel" }, "errorCode": { "type": [ "null", "string" ] }, "traceId": { "type": [ "null", "string" ] }, "ipAddress": { "type": [ "null", "string" ] }, "userAgent": { "type": [ "null", "string" ] }, "apiKeyPrefix": { "type": [ "null", "string" ] }, "isTest": { "type": "boolean" }, "requestBody": { "type": [ "null", "string" ] }, "responseBody": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" } } }, "AuditLogItem": { "required": [ "id", "adminId", "action", "targetType", "targetId", "changes", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "adminId": { "type": "string", "format": "uuid" }, "action": { "type": "string" }, "targetType": { "type": [ "null", "string" ] }, "targetId": { "type": [ "null", "string" ], "format": "uuid" }, "changes": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "createdAt": { "type": "string", "format": "date-time" } } }, "BlocklistCreateRequest": { "required": [ "type", "value", "reason", "expiresAt" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/BlocklistEntryType" }, "value": { "type": "string" }, "reason": { "type": "string" }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "BlocklistEntryItem": { "required": [ "id", "type", "value", "reason", "createdByAdminId", "expiresAt", "hitCount", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "$ref": "#/components/schemas/BlocklistEntryType" }, "value": { "type": "string" }, "reason": { "type": "string" }, "createdByAdminId": { "type": "string", "format": "uuid" }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" }, "hitCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" } } }, "BlocklistEntryType": { "type": "integer" }, "BreakdownItem": { "required": [ "key", "count" ], "type": "object", "properties": { "key": { "type": "string" }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "BreakdownResponse": { "required": [ "dim", "from", "to", "items" ], "type": "object", "properties": { "dim": { "type": "string" }, "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/BreakdownItem" } } } }, "CertificateHistoryItem": { "required": [ "id", "status", "issuedAt", "expiresAt", "locked", "revokedAt", "revokeReason" ], "type": "object", "properties": { "id": { "type": "string" }, "status": { "$ref": "#/components/schemas/CertificateStatus" }, "issuedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "locked": { "type": "boolean" }, "revokedAt": { "type": [ "null", "string" ], "format": "date-time" }, "revokeReason": { "type": [ "null", "string" ] } } }, "CertificateIssueRequest": { "required": [ "otpCode", "pin" ], "type": "object", "properties": { "otpCode": { "type": "string" }, "pin": { "type": "string" } } }, "CertificateResponse": { "required": [ "id", "endUserId", "kycRequestId", "externalCaReference", "status", "issuedAt", "expiresAt", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "endUserId": { "type": "string" }, "kycRequestId": { "type": "string" }, "externalCaReference": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/CertificateStatus" }, "issuedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "locked": { "type": "boolean", "default": false }, "revokedAt": { "type": [ "null", "string" ], "format": "date-time" }, "revokeReason": { "type": [ "null", "string" ] } } }, "CertificateRevocationRequestResponse": { "required": [ "id", "certificateId", "companyId", "reason", "status", "decidedAt", "decisionNote", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "certificateId": { "type": "string" }, "companyId": { "type": "string", "format": "uuid" }, "reason": { "type": "string" }, "status": { "$ref": "#/components/schemas/CertificateRevocationRequestStatus" }, "decidedAt": { "type": [ "null", "string" ], "format": "date-time" }, "decisionNote": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" } } }, "CertificateRevocationRequestStatus": { "type": "integer" }, "CertificateStatus": { "type": "integer" }, "ChangeCompanyPasswordRequest": { "required": [ "currentPassword", "newPassword" ], "type": "object", "properties": { "currentPassword": { "type": "string" }, "newPassword": { "type": "string" } } }, "CompanyCreateRequest": { "required": [ "name", "contactEmail" ], "type": "object", "properties": { "name": { "type": "string" }, "contactEmail": { "type": "string" }, "currency": { "type": [ "null", "string" ] }, "kycUnitPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "vatPercent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "lowBalanceThreshold": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "CompanyDashboardStatsResponse": { "required": [ "totalKycRequests", "kycCompletedToday", "kycInProgress", "kycCompletedTotal", "kycRejectedTotal", "kycSuccessRate", "inProgressByStep", "totalSignRequests", "signRequestsCompleted", "activeCertificates", "walletBalance", "walletReserved" ], "type": "object", "properties": { "totalKycRequests": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "kycCompletedToday": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "kycInProgress": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "kycCompletedTotal": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "kycRejectedTotal": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "kycSuccessRate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "inProgressByStep": { "type": "object", "additionalProperties": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "totalSignRequests": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "signRequestsCompleted": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "activeCertificates": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "walletBalance": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "walletReserved": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "CompanyDetailResponse": { "required": [ "id", "name", "contactEmail", "isActive", "currency", "kycUnitPrice", "vatPercent", "lowBalanceThreshold", "suspendedAt", "walletBalance", "walletReserved", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contactEmail": { "type": "string" }, "isActive": { "type": "boolean" }, "currency": { "type": "string" }, "kycUnitPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "vatPercent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "lowBalanceThreshold": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "suspendedAt": { "type": [ "null", "string" ], "format": "date-time" }, "walletBalance": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "walletReserved": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" } } }, "CompanyLoginCommand": { "required": [ "email", "password" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" } } }, "CompanyLogoutCommand": { "required": [ "refreshToken" ], "type": "object", "properties": { "refreshToken": { "type": "string" } } }, "CompanyOverridesResponse": { "required": [ "companyId", "webhooksPaused", "sandboxOnly", "rateLimitMultiplier" ], "type": "object", "properties": { "companyId": { "type": "string", "format": "uuid" }, "webhooksPaused": { "type": "boolean" }, "sandboxOnly": { "type": "boolean" }, "rateLimitMultiplier": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "CompanyProfileDetailResponse": { "required": [ "companyId", "name", "contactEmail", "isActive", "createdAt" ], "type": "object", "properties": { "companyId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contactEmail": { "type": "string" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" } } }, "CompanyProfileResponse": { "required": [ "accountId", "companyId", "email", "name", "contactEmail", "isActive", "currency", "kycUnitPrice", "vatPercent", "lowBalanceThreshold", "suspendedAt" ], "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "contactEmail": { "type": "string" }, "isActive": { "type": "boolean" }, "currency": { "type": "string" }, "kycUnitPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "vatPercent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "lowBalanceThreshold": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "suspendedAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "CompanyRefreshCommand": { "required": [ "refreshToken" ], "type": "object", "properties": { "refreshToken": { "type": "string" } } }, "CompanyResponse": { "required": [ "id", "name", "contactEmail", "isActive", "currency", "kycUnitPrice", "vatPercent", "lowBalanceThreshold", "suspendedAt", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contactEmail": { "type": "string" }, "isActive": { "type": "boolean" }, "currency": { "type": "string" }, "kycUnitPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "vatPercent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "lowBalanceThreshold": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "suspendedAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" } } }, "CompanyUpdateRequest": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "contactEmail": { "type": [ "null", "string" ] }, "isActive": { "type": [ "null", "boolean" ] }, "currency": { "type": [ "null", "string" ] }, "kycUnitPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "vatPercent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "lowBalanceThreshold": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "isSuspended": { "type": [ "null", "boolean" ] } } }, "CompanyWalletResponse": { "required": [ "companyId", "balance", "reserved", "available", "updatedAt" ], "type": "object", "properties": { "companyId": { "type": "string", "format": "uuid" }, "balance": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "reserved": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "available": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "ContactAccepted": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string" } } }, "ContactMessageItem": { "required": [ "id", "name", "email", "company", "subject", "message", "ip", "userAgent", "status", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "company": { "type": [ "null", "string" ] }, "subject": { "type": [ "null", "string" ] }, "message": { "type": "string" }, "ip": { "type": [ "null", "string" ] }, "userAgent": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/ContactMessageStatus" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "ContactMessageStatus": { "type": "integer" }, "ContactRequest": { "required": [ "name", "email", "company", "subject", "message", "website" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "company": { "type": [ "null", "string" ] }, "subject": { "type": [ "null", "string" ] }, "message": { "type": [ "null", "string" ] }, "website": { "type": [ "null", "string" ] } } }, "CreateApiKeyRequest": { "type": "object", "properties": { "entityId": { "type": [ "null", "string" ], "format": "uuid" }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" }, "label": { "type": [ "null", "string" ] }, "allowedIps": { "type": [ "null", "array" ], "items": { "type": "string" } }, "isTest": { "type": "boolean", "default": false } } }, "CreateSignRequestBody": { "required": [ "creatorEndUserId", "documentId", "signers" ], "type": "object", "properties": { "creatorEndUserId": { "type": "string" }, "documentId": { "type": "string" }, "signers": { "type": "array", "items": { "$ref": "#/components/schemas/SignerCreate" } }, "title": { "type": [ "null", "string" ] }, "message": { "type": [ "null", "string" ] }, "isOrdered": { "type": "boolean", "default": false }, "allowedIps": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "CreditReferenceType": { "type": "integer" }, "CreditTransactionResponse": { "required": [ "id", "type", "amount", "referenceType", "referenceId", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/components/schemas/CreditTransactionType" }, "amount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "referenceType": { "$ref": "#/components/schemas/CreditReferenceType" }, "referenceId": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" } } }, "CreditTransactionType": { "type": "integer" }, "DashboardStatsResponse": { "required": [ "totalCompanies", "activeCompanies", "totalKycRequests", "kycCompletedToday", "kycInProgress", "kycCompletedTotal", "kycRejectedTotal", "kycSuccessRate", "kycInProgressByStep", "totalSignRequests", "signRequestsCompleted", "totalCertificatesActive", "totalRevenuePaid", "pendingExtraKycRequests" ], "type": "object", "properties": { "totalCompanies": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "activeCompanies": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "totalKycRequests": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "kycCompletedToday": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "kycInProgress": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "kycCompletedTotal": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "kycRejectedTotal": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "kycSuccessRate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "kycInProgressByStep": { "type": "object", "additionalProperties": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "totalSignRequests": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "signRequestsCompleted": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "totalCertificatesActive": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "totalRevenuePaid": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "pendingExtraKycRequests": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "DeadLetterItem": { "required": [ "kind", "id", "reference", "lastError", "attempts", "createdAt" ], "type": "object", "properties": { "kind": { "type": "string" }, "id": { "type": "string", "format": "uuid" }, "reference": { "type": "string" }, "lastError": { "type": [ "null", "string" ] }, "attempts": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" } } }, "DocsInfoResponse": { "required": [ "openapiUrl", "message" ], "type": "object", "properties": { "openapiUrl": { "type": "string" }, "message": { "type": "string" } } }, "DocumentInfoSubmitRequest": { "type": "object", "properties": { "documentNumber": { "type": [ "null", "string" ] }, "surname": { "type": [ "null", "string" ] }, "givenNames": { "type": [ "null", "string" ] }, "nationality": { "type": [ "null", "string" ] }, "birthDate": { "type": [ "null", "string" ] }, "sex": { "type": [ "null", "string" ] }, "issueDate": { "type": [ "null", "string" ] }, "expiryDate": { "type": [ "null", "string" ] }, "issuingCountry": { "type": [ "null", "string" ] }, "personalNumber": { "type": [ "null", "string" ] }, "placeOfBirth": { "type": [ "null", "string" ] }, "fatherName": { "type": [ "null", "string" ] } } }, "DurationsAnalyticsResponse": { "required": [ "from", "to", "steps" ], "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "steps": { "type": "array", "items": { "$ref": "#/components/schemas/StepDurationStats" } } } }, "EmailOutboxItem": { "required": [ "id", "toEmail", "template", "status", "attempts", "nextRetryAt", "sentAt", "lastError", "relatedType", "relatedId", "isTest", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "toEmail": { "type": "string" }, "template": { "type": "string" }, "status": { "$ref": "#/components/schemas/EmailOutboxStatus" }, "attempts": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "nextRetryAt": { "type": [ "null", "string" ], "format": "date-time" }, "sentAt": { "type": [ "null", "string" ], "format": "date-time" }, "lastError": { "type": [ "null", "string" ] }, "relatedType": { "type": [ "null", "string" ] }, "relatedId": { "type": [ "null", "string" ], "format": "uuid" }, "isTest": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" } } }, "EmailOutboxStatus": { "type": "integer" }, "EndUserCertificatesResponse": { "required": [ "endUserId", "active", "history" ], "type": "object", "properties": { "endUserId": { "type": "string" }, "active": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CertificateHistoryItem" } ] }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/CertificateHistoryItem" } } } }, "EndUserExportResponse": { "required": [ "endUser", "kycRequests", "certificates", "signParticipations" ], "type": "object", "properties": { "endUser": { }, "kycRequests": { "type": "array" }, "certificates": { "type": "array" }, "signParticipations": { "type": "array" } } }, "EndUserLookupResponse": { "required": [ "endUserId", "latestKycStatus", "certificateStatus" ], "type": "object", "properties": { "endUserId": { "type": "string" }, "latestKycStatus": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/KycRequestStatus" } ] }, "certificateStatus": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CertificateStatus" } ] } } }, "ErrorsAnalyticsResponse": { "required": [ "from", "to", "items" ], "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TopErrorItem" } } } }, "ExternalCallLogItem": { "required": [ "id", "provider", "operation", "relatedType", "relatedId", "requestJson", "responseJson", "statusCode", "outcome", "durationMs", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "provider": { "type": "string" }, "operation": { "type": "string" }, "relatedType": { "type": [ "null", "string" ] }, "relatedId": { "type": [ "null", "string" ], "format": "uuid" }, "requestJson": { "type": [ "null", "string" ] }, "responseJson": { "type": [ "null", "string" ] }, "statusCode": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "outcome": { "$ref": "#/components/schemas/ExternalCallOutcome" }, "durationMs": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" } } }, "ExternalCallOutcome": { "type": "integer" }, "ExtraKycApproveRequest": { "required": [ "unitPrice" ], "type": "object", "properties": { "unitPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "ExtraKycRejectRequest": { "type": "object", "properties": { "reason": { "type": [ "null", "string" ] } } }, "ExtraKycRequestCreate": { "required": [ "creditsRequested" ], "type": "object", "properties": { "creditsRequested": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "reason": { "type": [ "null", "string" ] } } }, "ExtraKycRequestResponse": { "required": [ "id", "companyId", "creditsRequested", "status", "invoiceId", "reason", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "companyId": { "type": "string", "format": "uuid" }, "creditsRequested": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "status": { "$ref": "#/components/schemas/ExtraKycRequestStatus" }, "invoiceId": { "type": [ "null", "string" ] }, "reason": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" } } }, "ExtraKycRequestStatus": { "type": "integer" }, "FunnelResponse": { "required": [ "from", "to", "started", "steps" ], "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "started": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "steps": { "type": "array", "items": { "$ref": "#/components/schemas/FunnelStep" } } } }, "FunnelStep": { "required": [ "step", "reached", "conversionFromPrevious" ], "type": "object", "properties": { "step": { "type": "string" }, "reached": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "conversionFromPrevious": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "HeldReservationItem": { "required": [ "kycRequestId", "companyId", "status", "createdAt", "ageHours" ], "type": "object", "properties": { "kycRequestId": { "type": "string" }, "companyId": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "ageHours": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "IFormFile": { "type": "string", "format": "binary" }, "InvoiceCreateRequest": { "required": [ "kycQuantity" ], "type": "object", "properties": { "kycQuantity": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "unitPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "currency": { "type": [ "null", "string" ] }, "vatPercent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "dueDate": { "type": [ "null", "string" ], "format": "date-time" }, "notes": { "type": [ "null", "string" ] } } }, "InvoiceResponse": { "required": [ "id", "companyId", "invoiceNumber", "kycQuantity", "unitPrice", "currency", "subtotal", "vatPercent", "vatAmount", "totalAmount", "status", "dueDate", "notes", "hasDocument", "sentAt", "paidAt", "cancelledAt", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "companyId": { "type": "string", "format": "uuid" }, "invoiceNumber": { "type": [ "null", "string" ] }, "kycQuantity": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "unitPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "currency": { "type": "string" }, "subtotal": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "vatPercent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "vatAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "status": { "$ref": "#/components/schemas/InvoiceStatus" }, "dueDate": { "type": [ "null", "string" ], "format": "date-time" }, "notes": { "type": [ "null", "string" ] }, "hasDocument": { "type": "boolean" }, "sentAt": { "type": [ "null", "string" ], "format": "date-time" }, "paidAt": { "type": [ "null", "string" ], "format": "date-time" }, "cancelledAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" } } }, "InvoiceStatus": { "type": "integer" }, "JsonElement": { }, "KycDocumentInfoView": { "required": [ "documentType", "documentNumber", "surname", "givenNames", "birthDate", "sex", "nationality", "issuingCountry", "expiryDate", "personalNumber", "placeOfBirth", "fatherName", "revealed" ], "type": "object", "properties": { "documentType": { "$ref": "#/components/schemas/KycDocumentType" }, "documentNumber": { "type": "string" }, "surname": { "type": "string" }, "givenNames": { "type": "string" }, "birthDate": { "type": "string" }, "sex": { "type": "string" }, "nationality": { "type": [ "null", "string" ] }, "issuingCountry": { "type": [ "null", "string" ] }, "expiryDate": { "type": "string" }, "personalNumber": { "type": [ "null", "string" ] }, "placeOfBirth": { "type": [ "null", "string" ] }, "fatherName": { "type": [ "null", "string" ] }, "revealed": { "type": "boolean" } } }, "KycDocumentType": { "type": "integer" }, "KycEndUserResponse": { "required": [ "id", "companyId", "email", "fullName", "phone", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "companyId": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "fullName": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" } } }, "KycOtpVerifyRequest": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string" } } }, "KycRequestComplianceDetailResponse": { "required": [ "request", "documentInfo" ], "type": "object", "properties": { "request": { "$ref": "#/components/schemas/KycRequestDetailResponse" }, "documentInfo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/KycDocumentInfoView" } ] } } }, "KycRequestCreateRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" }, "fullName": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "documentType": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/KycDocumentType" } ] } } }, "KycRequestDetailResponse": { "required": [ "id", "status", "documentType", "steps", "endUserId", "createdAt", "completedAt" ], "type": "object", "properties": { "id": { "type": "string" }, "status": { "$ref": "#/components/schemas/KycRequestStatus" }, "documentType": { "$ref": "#/components/schemas/KycDocumentType" }, "steps": { "type": "array", "items": { "$ref": "#/components/schemas/KycStepState" } }, "endUserId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "KycRequestResponse": { "required": [ "id", "endUserId", "companyId", "status", "documentType", "completedAt", "expiresAt", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "endUserId": { "type": "string" }, "companyId": { "type": "string", "format": "uuid" }, "status": { "$ref": "#/components/schemas/KycRequestStatus" }, "documentType": { "$ref": "#/components/schemas/KycDocumentType" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time" }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "testOtp": { "type": [ "null", "string" ] } } }, "KycRequestStatus": { "type": "integer" }, "KycStartRequest": { "type": "object", "properties": { "fullName": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] } } }, "KycStepState": { "required": [ "step", "status" ], "type": "object", "properties": { "step": { "type": "string" }, "status": { "type": "string" }, "attempts": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "failureReason": { "type": [ "null", "string" ] }, "at": { "type": [ "null", "string" ], "format": "date-time" } } }, "ManualReceiptRequest": { "required": [ "receiptReference" ], "type": "object", "properties": { "receiptReference": { "type": "string" }, "notes": { "type": [ "null", "string" ] } } }, "MonitorCertificateItem": { "required": [ "id", "endUserId", "status", "issuedAt", "expiresAt", "internalId" ], "type": "object", "properties": { "id": { "type": "string" }, "endUserId": { "type": "string" }, "status": { "$ref": "#/components/schemas/CertificateStatus" }, "issuedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "internalId": { "type": "string", "format": "uuid" } } }, "MonitorKycRequestItem": { "required": [ "id", "companyId", "endUserId", "status", "createdAt", "completedAt", "internalId" ], "type": "object", "properties": { "id": { "type": "string" }, "companyId": { "type": "string", "format": "uuid" }, "endUserId": { "type": "string" }, "status": { "$ref": "#/components/schemas/KycRequestStatus" }, "createdAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time" }, "internalId": { "type": "string", "format": "uuid" } } }, "MonitorSignRequestItem": { "required": [ "id", "companyId", "status", "createdAt", "internalId" ], "type": "object", "properties": { "id": { "type": "string" }, "companyId": { "type": "string", "format": "uuid" }, "status": { "$ref": "#/components/schemas/SignRequestStatus" }, "createdAt": { "type": "string", "format": "date-time" }, "internalId": { "type": "string", "format": "uuid" } } }, "OtpVerifyRequest": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string" } } }, "OverridesUpdateRequest": { "required": [ "webhooksPaused", "sandboxOnly", "rateLimitMultiplier", "note" ], "type": "object", "properties": { "webhooksPaused": { "type": [ "null", "boolean" ] }, "sandboxOnly": { "type": [ "null", "boolean" ] }, "rateLimitMultiplier": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "note": { "type": [ "null", "string" ] } } }, "PaginatedResponseOfAdminWalletItem": { "required": [ "items", "total", "limit", "offset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AdminWalletItem" } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PaginatedResponseOfAlertEventItem": { "required": [ "items", "total", "limit", "offset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AlertEventItem" } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PaginatedResponseOfAlertRuleItem": { "required": [ "items", "total", "limit", "offset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AlertRuleItem" } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PaginatedResponseOfAuditLogItem": { "required": [ "items", "total", "limit", "offset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AuditLogItem" } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PaginatedResponseOfBlocklistEntryItem": { "required": [ "items", "total", "limit", "offset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BlocklistEntryItem" } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PaginatedResponseOfCertificateResponse": { "required": [ "items", "total", "limit", "offset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CertificateResponse" } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PaginatedResponseOfCertificateRevocationRequestResponse": { "required": [ "items", "total", "limit", "offset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CertificateRevocationRequestResponse" } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PaginatedResponseOfCompanyResponse": { "required": [ "items", "total", "limit", "offset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyResponse" } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PaginatedResponseOfCreditTransactionResponse": { "required": [ "items", "total", "limit", "offset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CreditTransactionResponse" } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PaginatedResponseOfExtraKycRequestResponse": { "required": [ "items", "total", "limit", "offset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ExtraKycRequestResponse" } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PaginatedResponseOfInvoiceResponse": { "required": [ "items", "total", "limit", "offset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceResponse" } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PaginatedResponseOfKycEndUserResponse": { "required": [ "items", "total", "limit", "offset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/KycEndUserResponse" } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PaginatedResponseOfKycRequestResponse": { "required": [ "items", "total", "limit", "offset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/KycRequestResponse" } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PaginatedResponseOfMonitorCertificateItem": { "required": [ "items", "total", "limit", "offset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MonitorCertificateItem" } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PaginatedResponseOfMonitorKycRequestItem": { "required": [ "items", "total", "limit", "offset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MonitorKycRequestItem" } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PaginatedResponseOfMonitorSignRequestItem": { "required": [ "items", "total", "limit", "offset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MonitorSignRequestItem" } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PaginatedResponseOfPiiAccessLogItem": { "required": [ "items", "total", "limit", "offset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PiiAccessLogItem" } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PaginatedResponseOfReportRunItem": { "required": [ "items", "total", "limit", "offset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportRunItem" } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PaginatedResponseOfSignRequestResponse": { "required": [ "items", "total", "limit", "offset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SignRequestResponse" } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PaginatedResponseOfSoftDeletedItemDto": { "required": [ "items", "total", "limit", "offset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SoftDeletedItemDto" } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PaginatedResponseOfWebhookEndpointResponse": { "required": [ "items", "total", "limit", "offset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEndpointResponse" } }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PiiAccessLogItem": { "required": [ "id", "accessorType", "accessorId", "resourceType", "resourceId", "fieldSet", "reason", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "accessorType": { "$ref": "#/components/schemas/PiiAccessorType" }, "accessorId": { "type": "string", "format": "uuid" }, "resourceType": { "type": "string" }, "resourceId": { "type": "string", "format": "uuid" }, "fieldSet": { "type": "string" }, "reason": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" } } }, "PiiAccessorType": { "type": "integer" }, "PinResetConfirmRequest": { "required": [ "otpCode", "newPin" ], "type": "object", "properties": { "otpCode": { "type": "string" }, "newPin": { "type": "string" } } }, "PlatformSwitches": { "required": [ "maintenanceMode", "killKycCreate", "killSigning", "killCertificates", "pauseWebhooks", "pauseEmails", "pauseValidation" ], "type": "object", "properties": { "maintenanceMode": { "type": "boolean" }, "killKycCreate": { "type": "boolean" }, "killSigning": { "type": "boolean" }, "killCertificates": { "type": "boolean" }, "pauseWebhooks": { "type": "boolean" }, "pauseEmails": { "type": "boolean" }, "pauseValidation": { "type": "boolean" } } }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] } } }, "QuartzJobStatus": { "required": [ "name", "previousFireTimeUtc", "nextFireTimeUtc" ], "type": "object", "properties": { "name": { "type": "string" }, "previousFireTimeUtc": { "type": [ "null", "string" ], "format": "date-time" }, "nextFireTimeUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "QueryPageOfApiRequestLogItem": { "required": [ "items", "limit" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ApiRequestLogItem" } }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "nextCursor": { "type": [ "null", "string" ] } } }, "QueryPageOfContactMessageItem": { "required": [ "items", "limit" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ContactMessageItem" } }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "nextCursor": { "type": [ "null", "string" ] } } }, "QueryPageOfEmailOutboxItem": { "required": [ "items", "limit" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EmailOutboxItem" } }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "nextCursor": { "type": [ "null", "string" ] } } }, "QueryPageOfExternalCallLogItem": { "required": [ "items", "limit" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalCallLogItem" } }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "nextCursor": { "type": [ "null", "string" ] } } }, "QueryPageOfWebhookDeliveryResponse": { "required": [ "items", "limit" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookDeliveryResponse" } }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "nextCursor": { "type": [ "null", "string" ] } } }, "ReleaseRequest": { "required": [ "kycRequestIds" ], "type": "object", "properties": { "kycRequestIds": { "type": "array", "items": { "type": "string" } } } }, "ReleaseReservationsResponse": { "required": [ "released", "skipped" ], "type": "object", "properties": { "released": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "skipped": { "type": "array", "items": { "type": "string" } } } }, "ReportDefinitionCreateRequest": { "required": [ "name", "source", "columns", "filters", "sort", "cron" ], "type": "object", "properties": { "name": { "type": "string" }, "source": { "$ref": "#/components/schemas/ReportSource" }, "columns": { "type": "array", "items": { "type": "string" } }, "filters": { "type": [ "null", "string" ] }, "sort": { "type": [ "null", "string" ] }, "cron": { "type": [ "null", "string" ] } } }, "ReportDefinitionItem": { "required": [ "id", "name", "source", "columns", "filters", "sort", "ownerType", "cron", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "source": { "$ref": "#/components/schemas/ReportSource" }, "columns": { "type": "array", "items": { "type": "string" } }, "filters": { "type": [ "null", "string" ] }, "sort": { "type": [ "null", "string" ] }, "ownerType": { "$ref": "#/components/schemas/ReportOwnerType" }, "cron": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" } } }, "ReportDefinitionUpdateRequest": { "required": [ "name", "columns", "filters", "sort", "cron" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "columns": { "type": [ "null", "array" ], "items": { "type": "string" } }, "filters": { "type": [ "null", "string" ] }, "sort": { "type": [ "null", "string" ] }, "cron": { "type": [ "null", "string" ] } } }, "ReportDownloadResponse": { "required": [ "url", "completedAt", "rowCount" ], "type": "object", "properties": { "url": { "type": "string" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time" }, "rowCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "ReportOwnerType": { "type": "integer" }, "ReportRunItem": { "required": [ "id", "reportId", "status", "rowCount", "error", "createdAt", "completedAt" ], "type": "object", "properties": { "id": { "type": "string" }, "reportId": { "type": "string" }, "status": { "$ref": "#/components/schemas/ReportRunStatus" }, "rowCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "error": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "ReportRunStatus": { "type": "integer" }, "ReportSource": { "type": "integer" }, "ResolveRequest": { "required": [ "passed", "note" ], "type": "object", "properties": { "passed": { "type": "boolean" }, "note": { "type": [ "null", "string" ] } } }, "RetentionStatusItem": { "required": [ "companyId", "companyName", "mediaObjectCount", "oldestLogAt", "oldestLogAgeDays" ], "type": "object", "properties": { "companyId": { "type": "string", "format": "uuid" }, "companyName": { "type": "string" }, "mediaObjectCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "oldestLogAt": { "type": [ "null", "string" ], "format": "date-time" }, "oldestLogAgeDays": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "RetriesAnalyticsResponse": { "required": [ "from", "to", "steps", "stuckInRetry" ], "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "steps": { "type": "array", "items": { "$ref": "#/components/schemas/StepRetryDistribution" } }, "stuckInRetry": { "type": "array", "items": { "$ref": "#/components/schemas/StuckRequestItem" } } } }, "RevocationRejectRequest": { "type": "object", "properties": { "note": { "type": [ "null", "string" ] } } }, "RevocationRequestCreate": { "required": [ "reason" ], "type": "object", "properties": { "reason": { "type": "string" } } }, "RevokeCertificateRequest": { "required": [ "reason" ], "type": "object", "properties": { "reason": { "type": "string" } } }, "RiskDuplicateDocumentRow": { "required": [ "documentNumberLookup", "endUserCount" ], "type": "object", "properties": { "documentNumberLookup": { "type": "string" }, "endUserCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "RiskFailedAttemptsRow": { "required": [ "kycRequestId", "kycRequestPublicId", "companyId", "failedAttempts" ], "type": "object", "properties": { "kycRequestId": { "type": "string", "format": "uuid" }, "kycRequestPublicId": { "type": "string" }, "companyId": { "type": "string", "format": "uuid" }, "failedAttempts": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "RiskIpBurstRow": { "required": [ "ipAddress", "kycCreates24h" ], "type": "object", "properties": { "ipAddress": { "type": "string" }, "kycCreates24h": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "RiskSignalsResponse": { "required": [ "duplicateDocumentNumbers", "ipBursts", "repeatedFailures" ], "type": "object", "properties": { "duplicateDocumentNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/RiskDuplicateDocumentRow" } }, "ipBursts": { "type": "array", "items": { "$ref": "#/components/schemas/RiskIpBurstRow" } }, "repeatedFailures": { "type": "array", "items": { "$ref": "#/components/schemas/RiskFailedAttemptsRow" } } } }, "SelfieSubmitRequest": { "required": [ "storageKey" ], "type": "object", "properties": { "storageKey": { "type": "string" } } }, "SignCertificateIssueRequest": { "required": [ "otpCode", "pin" ], "type": "object", "properties": { "otpCode": { "type": "string" }, "pin": { "type": "string" } } }, "SignDocumentVersionResponse": { "required": [ "version", "producedBySignerId", "createdAt" ], "type": "object", "properties": { "version": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "producedBySignerId": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" } } }, "SignerCreate": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" }, "orderIndex": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "SignerDetail": { "required": [ "id", "email", "status", "orderIndex", "signedAt", "ipAddress" ], "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "status": { "$ref": "#/components/schemas/SignerStatus" }, "orderIndex": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "signedAt": { "type": [ "null", "string" ], "format": "date-time" }, "ipAddress": { "type": [ "null", "string" ] } } }, "SignerStatus": { "type": "integer" }, "SignerStatusResponse": { "required": [ "signerId", "signRequestId", "status", "email", "nextStep", "title", "message", "pageCount", "companyName", "isOrdered", "orderIndex" ], "type": "object", "properties": { "signerId": { "type": "string" }, "signRequestId": { "type": "string" }, "status": { "$ref": "#/components/schemas/SignerStatus" }, "email": { "type": "string" }, "nextStep": { "type": "string" }, "title": { "type": [ "null", "string" ] }, "message": { "type": [ "null", "string" ] }, "pageCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "companyName": { "type": [ "null", "string" ] }, "isOrdered": { "type": "boolean" }, "orderIndex": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "SignerSummary": { "required": [ "id", "email", "status", "token", "orderIndex", "signedAt" ], "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "status": { "$ref": "#/components/schemas/SignerStatus" }, "token": { "type": "string" }, "orderIndex": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "signedAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "SignEventResponse": { "required": [ "eventType", "signerId", "ipAddress", "userAgent", "createdAt" ], "type": "object", "properties": { "eventType": { "type": "string" }, "signerId": { "type": [ "null", "string" ] }, "ipAddress": { "type": [ "null", "string" ] }, "userAgent": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" } } }, "SignRequestDetailResponse": { "required": [ "id", "companyId", "status", "creatorEndUserId", "title", "message", "isOrdered", "allowedIps", "originalFilename", "fileSize", "pageCount", "isTest", "signers", "events", "versions", "cancelledAt", "completedAt", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "companyId": { "type": "string", "format": "uuid" }, "status": { "$ref": "#/components/schemas/SignRequestStatus" }, "creatorEndUserId": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "message": { "type": [ "null", "string" ] }, "isOrdered": { "type": "boolean" }, "allowedIps": { "type": "array", "items": { "type": "string" } }, "originalFilename": { "type": [ "null", "string" ] }, "fileSize": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "pageCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "isTest": { "type": "boolean" }, "signers": { "type": "array", "items": { "$ref": "#/components/schemas/SignerDetail" } }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/SignEventResponse" } }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/SignDocumentVersionResponse" } }, "cancelledAt": { "type": [ "null", "string" ], "format": "date-time" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" } } }, "SignRequestResponse": { "required": [ "id", "companyId", "status", "title", "message", "isOrdered", "allowedIps", "originalFilename", "fileSize", "pageCount", "isTest", "signers", "cancelledAt", "completedAt", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "companyId": { "type": "string", "format": "uuid" }, "status": { "$ref": "#/components/schemas/SignRequestStatus" }, "title": { "type": [ "null", "string" ] }, "message": { "type": [ "null", "string" ] }, "isOrdered": { "type": "boolean" }, "allowedIps": { "type": "array", "items": { "type": "string" } }, "originalFilename": { "type": [ "null", "string" ] }, "fileSize": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "pageCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "isTest": { "type": "boolean" }, "signers": { "type": "array", "items": { "$ref": "#/components/schemas/SignerSummary" } }, "cancelledAt": { "type": [ "null", "string" ], "format": "date-time" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" } } }, "SignRequestStatus": { "type": "integer" }, "SoftDeletedItemDto": { "required": [ "id", "deletedAt", "deletedBy", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "deletedAt": { "type": [ "null", "string" ], "format": "date-time" }, "deletedBy": { "type": [ "null", "string" ] }, "createdAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "StatusRequest": { "required": [ "status" ], "type": "object", "properties": { "status": { "$ref": "#/components/schemas/ContactMessageStatus" } } }, "StepAttemptBucket": { "required": [ "attempts", "requests" ], "type": "object", "properties": { "attempts": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "requests": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "StepDurationStats": { "required": [ "step", "samples", "medianSeconds", "p95Seconds" ], "type": "object", "properties": { "step": { "type": "string" }, "samples": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "medianSeconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "p95Seconds": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "StepRetryDistribution": { "required": [ "step", "distribution" ], "type": "object", "properties": { "step": { "type": "string" }, "distribution": { "type": "array", "items": { "$ref": "#/components/schemas/StepAttemptBucket" } } } }, "StuckRequestItem": { "required": [ "kycRequestId", "companyId", "status", "failedAttempts", "createdAt" ], "type": "object", "properties": { "kycRequestId": { "type": "string" }, "companyId": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "failedAttempts": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" } } }, "StuckSubmissionItem": { "required": [ "submissionType", "submissionId", "kycRequestId", "companyId", "isTest", "submittedAt", "ageMinutes" ], "type": "object", "properties": { "submissionType": { "type": "string" }, "submissionId": { "type": "string", "format": "uuid" }, "kycRequestId": { "type": "string" }, "companyId": { "type": "string", "format": "uuid" }, "isTest": { "type": "boolean" }, "submittedAt": { "type": "string", "format": "date-time" }, "ageMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "SwitchesUpdateRequest": { "required": [ "maintenanceMode", "killKycCreate", "killSigning", "killCertificates", "pauseWebhooks", "pauseEmails", "pauseValidation" ], "type": "object", "properties": { "maintenanceMode": { "type": [ "null", "boolean" ] }, "killKycCreate": { "type": [ "null", "boolean" ] }, "killSigning": { "type": [ "null", "boolean" ] }, "killCertificates": { "type": [ "null", "boolean" ] }, "pauseWebhooks": { "type": [ "null", "boolean" ] }, "pauseEmails": { "type": [ "null", "boolean" ] }, "pauseValidation": { "type": [ "null", "boolean" ] } } }, "SystemHealthResponse": { "required": [ "pendingEmailOutbox", "pendingWebhookDeliveries", "validatingSubmissions", "dbHealthy", "dbPingMs", "redisHealthy", "redisPingMs", "quartzJobs" ], "type": "object", "properties": { "pendingEmailOutbox": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "pendingWebhookDeliveries": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "validatingSubmissions": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "dbHealthy": { "type": "boolean" }, "dbPingMs": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "redisHealthy": { "type": "boolean" }, "redisPingMs": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "quartzJobs": { "type": "array", "items": { "$ref": "#/components/schemas/QuartzJobStatus" } } } }, "TimeseriesPoint": { "required": [ "bucket", "metric", "value" ], "type": "object", "properties": { "bucket": { "type": "string", "format": "date-time" }, "metric": { "type": "string" }, "value": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "TimeseriesResponse": { "required": [ "from", "to", "bucket", "points" ], "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "bucket": { "type": "string" }, "points": { "type": "array", "items": { "$ref": "#/components/schemas/TimeseriesPoint" } } } }, "TopErrorItem": { "required": [ "path", "errorCode", "count" ], "type": "object", "properties": { "path": { "type": "string" }, "errorCode": { "type": "string" }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "TotpCodeRequest": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string" } } }, "UpdateApiKeyRequest": { "type": "object", "properties": { "label": { "type": [ "null", "string" ] }, "allowedIps": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "UpdateCompanyProfileRequest": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "contactEmail": { "type": [ "null", "string" ] } } }, "VideoSubmitRequest": { "required": [ "storageKey", "challengeCode" ], "type": "object", "properties": { "storageKey": { "type": "string" }, "challengeCode": { "type": "string" } } }, "WalletAdjustRequest": { "required": [ "amount", "reason" ], "type": "object", "properties": { "amount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "reason": { "type": "string" } } }, "WebhookDeliveryResponse": { "required": [ "id", "endpointId", "eventType", "eventId", "status", "attempts", "nextRetryAt", "lastResponseStatus", "lastError", "durationMs", "deliveredAt", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "endpointId": { "type": [ "null", "string" ] }, "eventType": { "type": "string" }, "eventId": { "type": "string" }, "status": { "$ref": "#/components/schemas/WebhookDeliveryStatus" }, "attempts": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "nextRetryAt": { "type": [ "null", "string" ], "format": "date-time" }, "lastResponseStatus": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "lastError": { "type": [ "null", "string" ] }, "durationMs": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "deliveredAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" } } }, "WebhookDeliveryStatus": { "type": "integer" }, "WebhookEndpointCreatedResponse": { "required": [ "id", "url", "events", "isActive", "description", "secret", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "isActive": { "type": "boolean" }, "description": { "type": [ "null", "string" ] }, "secret": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } } }, "WebhookEndpointCreateRequest": { "required": [ "url", "events", "description" ], "type": "object", "properties": { "url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "null", "string" ] } } }, "WebhookEndpointResponse": { "required": [ "id", "url", "events", "isActive", "description", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "isActive": { "type": "boolean" }, "description": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" } } }, "WebhookEndpointUpdateRequest": { "required": [ "url", "events", "isActive", "description" ], "type": "object", "properties": { "url": { "type": [ "null", "string" ] }, "events": { "type": [ "null", "array" ], "items": { "type": "string" } }, "isActive": { "type": [ "null", "boolean" ] }, "description": { "type": [ "null", "string" ] } } } } }, "tags": [ { "name": "AdminAdmins" }, { "name": "AdminAlerts" }, { "name": "AdminAnalytics" }, { "name": "AdminAuth" }, { "name": "AdminBilling" }, { "name": "AdminCertificates" }, { "name": "AdminCompliance" }, { "name": "AdminContactMessages" }, { "name": "AdminControl" }, { "name": "AdminCompanyOverrides" }, { "name": "AdminBlocklist" }, { "name": "AdminLogs" }, { "name": "AdminMonitoring" }, { "name": "CompanyDocs" }, { "name": "AdminOps" }, { "name": "AdminRecycleBin" }, { "name": "Certificates" }, { "name": "CompanyCertificatesMonitor" }, { "name": "CompanyRevocationRequests" }, { "name": "CompanyAnalytics" }, { "name": "CompanyLogs" }, { "name": "CompanyApiKeys" }, { "name": "CompanyAuth" }, { "name": "CompanyExtraKyc" }, { "name": "CompanyWallet" }, { "name": "CompanyInvoices" }, { "name": "CompanyKycMonitor" }, { "name": "CompanyProfile" }, { "name": "CompanyWebhooks" }, { "name": "CompanyWebhookDeliveries" }, { "name": "EndUsers" }, { "name": "Kyc" }, { "name": "Media" }, { "name": "PaymentWebhook" }, { "name": "PublicContact" }, { "name": "AdminReports" }, { "name": "CompanyReports" }, { "name": "Signer" }, { "name": "SignDocuments" }, { "name": "SignRequests" }, { "name": "CompanySigningMonitor" } ] }