> ## Documentation Index > Fetch the complete documentation index at: https://docs.fluidehr.com/llms.txt > Use this file to discover all available pages before exploring further. # Submit/replace KYB-KYC documents for super-admin review ## OpenAPI ````yaml /openapi/fluide-auth.json post /api/v1/onboarding/kyb/documents openapi: 3.0.0 info: title: Fluide Auth API description: >- Developer credentials, session management, and identity for the Fluide Suite. In the API playground, click Authorize and provide Bearer JWT, X-Fluide-Api-Key, and X-Fluide-Client-Id (fluide-developer). For partner / ISV integrations acting on a merchant, also set optional X-Workspace-Id and X-Acting-Company-Id on each request (see Multi-tenancy). version: '1.0' contact: {} servers: - url: https://test.api.fluidehr.com description: API security: - bearer: [] fluideApiKey: [] fluideClientId: [] tags: - name: auth description: '' - name: App description: Service root and build metadata. Use for quick connectivity checks. x-group: Operations - name: Auth Context - name: Health description: >- Liveness and readiness probes. Returns dependency status (database, Redis, etc.) for orchestrators and uptime monitors. x-group: Operations - name: auth-v1 - name: BetterAuthOAuthBridge - name: Auth - name: Authorize description: >- Exchange API key and secret for a machine JWT, read developer metadata, rotate secrets, and manage API billing. - name: Organizations - name: Company - name: Onboarding - name: organigram - name: org master data - name: org rbac - name: engagement - name: marketplace-admin - name: virtual manager - name: compliance-expert - name: Partner Marketplace - name: delegation audit - name: workspace - name: client-onboarding - name: partner-hub - name: cohort - name: investor portfolio - name: investor-portfolio - name: workflow - name: inter company paths: /api/v1/onboarding/kyb/documents: post: tags: - Onboarding summary: Submit/replace KYB-KYC documents for super-admin review operationId: OnboardingController_submitKybDocuments_v1 parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SubmitKybDocumentsDto' responses: '201': description: Created successfully content: application/json: schema: allOf: - $ref: '#/components/schemas/ApiResponseDto' - properties: data: description: Endpoint-specific payload '400': description: Validation failed or invalid request parameters content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponseDto' '401': description: Missing or invalid JWT / API key content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponseDto' '403': description: Token valid but insufficient permission for this operation content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponseDto' '404': description: Resource not found or outside caller scope content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponseDto' security: - bearer: [] fluideApiKey: [] fluideClientId: [] x-codeSamples: - lang: bash label: cURL source: >- curl -sS -X POST "$FLUIDE_BASE_URL/api/v1/onboarding/kyb/documents" \ -H "Authorization: Bearer $FLUIDE_ACCESS_TOKEN" \ -H "X-Fluide-Api-Key: $FLUIDE_API_KEY" \ -H "X-Fluide-Client-Id: fluide-developer" \ -H "Content-Type: application/json" \ -d '{}' - lang: node label: Node.js source: >- const baseUrl = process.env.FLUIDE_BASE_URL; const response = await fetch(`${baseUrl}/api/v1/onboarding/kyb/documents`, { method: 'POST', headers: { Authorization: `Bearer ${process.env.FLUIDE_ACCESS_TOKEN}`, 'X-Fluide-Api-Key': process.env.FLUIDE_API_KEY, 'X-Fluide-Client-Id': 'fluide-developer', 'Content-Type': 'application/json', }, body: JSON.stringify({}), }); if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`); console.log(await response.json()); - lang: python label: Python source: |- import os import requests base_url = os.environ["FLUIDE_BASE_URL"] headers = { "Authorization": f"Bearer {os.environ['FLUIDE_ACCESS_TOKEN']}", "X-Fluide-Api-Key": os.environ["FLUIDE_API_KEY"], "X-Fluide-Client-Id": "fluide-developer", } response = requests.post( f"{base_url}/api/v1/onboarding/kyb/documents", headers=headers, json={}, timeout=30, ) response.raise_for_status() print(response.json()) - lang: java label: Java source: >- import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; String baseUrl = System.getenv("FLUIDE_BASE_URL"); HttpClient client = HttpClient.newHttpClient(); HttpRequest.Builder builder = HttpRequest.newBuilder() .uri(URI.create(baseUrl + "/api/v1/onboarding/kyb/documents")) .header("Authorization", "Bearer " + System.getenv("FLUIDE_ACCESS_TOKEN")) .header("X-Fluide-Api-Key", System.getenv("FLUIDE_API_KEY")) .header("X-Fluide-Client-Id", "fluide-developer") .header("Content-Type", "application/json") .POST(HttpRequest.BodyPublishers.ofString("{}")) .build(); HttpResponse response = client.send(builder.build(), HttpResponse.BodyHandlers.ofString()); if (response.statusCode() >= 400) throw new RuntimeException("HTTP " + response.statusCode() + ": " + response.body()); System.out.println(response.body()); - lang: php label: PHP source: >- true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ' . getenv('FLUIDE_ACCESS_TOKEN'), 'X-Fluide-Api-Key: ' . getenv('FLUIDE_API_KEY'), 'X-Fluide-Client-Id: fluide-developer', 'Content-Type: application/json', ], CURLOPT_POSTFIELDS => "{}", ]); $response = curl_exec($ch); if ($response === false) throw new RuntimeException(curl_error($ch)); $status = curl_getinfo($ch, CURLINFO_HTTP_CODE); if ($status >= 400) throw new RuntimeException("HTTP $status: $response"); echo $response; components: schemas: SubmitKybDocumentsDto: type: object properties: applicantType: enum: - COMPANY - REFERRAL_PARTNER - SERVICE_PARTNER_FIRM - SERVICE_PARTNER_INDIVIDUAL type: string description: >- Submission profile. COMPANY is default for org KYB; partner values are for referral/service partner KYC-KYB. example: COMPANY tier: enum: - SILVER - GOLD - PLATINUM type: string description: >- Verification tier. For partner profiles this is still required for scoring/policy alignment, even when requirement sets are role-specific. countryCode: type: string description: >- ISO 3166-1 alpha-2 country code. Defaults to current company.countryCode when omitted. example: CM documents: description: >- Uploaded documents. Use document keys that match the selected applicantType requirement set. type: array items: $ref: '#/components/schemas/KybDocumentDto' required: - tier - documents ApiResponseDto: type: object properties: success: type: boolean example: true description: Whether the request succeeded message: type: string example: Operation completed successfully description: Human-readable outcome message (localized when i18n is configured) data: type: object description: Response payload when success is true required: - success - message ApiErrorResponseDto: type: object properties: success: type: boolean example: false message: type: string example: Validation failed description: Human-readable error message (localized when i18n is configured) code: type: string example: VALIDATION_FAILED description: Stable machine-readable error code for client handling and support errors: type: object description: Field-level validation errors keyed by property name example: from: - from must be a valid date statusCode: type: number example: 400 timestamp: type: string example: '2026-06-03T12:00:00.000Z' required: - success - message - code - statusCode - timestamp KybDocumentDto: type: object properties: type: enum: - BUSINESS_REGISTRATION_CERTIFICATE - TAX_IDENTIFICATION_NUMBER - PROOF_OF_BUSINESS_ADDRESS - DIRECTORS_AND_SHAREHOLDERS_ID - ARTICLES_OF_INCORPORATION - BENEFICIAL_OWNERSHIP_DECLARATION - BUSINESS_LICENSE - CERTIFICATE_OF_INCORPORATION - MEMORANDUM_AND_ARTICLES_OF_ASSOCIATION - CAC_FORM_CO7_OR_1_1 - BANK_VERIFICATION_NUMBER - NATIONAL_IDENTIFICATION_NUMBER - DIRECTORS_UTILITY_BILL - DIRECTORS_OR_PARTNERS_LIST - CERTIFICATE_OF_INCORPORATION_OR_STATUS - PROFESSIONAL_LICENSE_OR_CERTIFICATION - BANK_ACCOUNT_CONFIRMATION - BANK_ACCOUNT_DETAILS - CLIENT_LIST_SAMPLE - GOVERNMENT_ISSUED_ID - CV_OR_RESUME - PROFESSIONAL_REFERENCE - MULTI_BRANCH_REGISTRATION_CERTIFICATES - LOCAL_TAX_IDS_PER_BRANCH type: string description: >- Normalized document type key agreed with frontend and reviewer panel. example: BUSINESS_REGISTRATION_CERTIFICATE name: type: string description: Optional original document display name. example: rccm-certificate.pdf url: type: string format: uri description: >- Uploaded file URL (typically from file service/object storage). Required when fileId is not provided. example: https://cdn.fluide.com/kyb/org-123/rccm.pdf fileId: type: string format: uuid description: >- Optional file id from shared file service (`/api/v1/app/files`). When provided, KYB stores generated download URL automatically. issuedAt: type: string example: '2024-12-20' expiresAt: type: string example: '2027-12-20' metadata: type: object description: Optional free-form metadata (issuer, reference number, etc.). additionalProperties: true required: - type securitySchemes: bearer: type: http scheme: bearer bearerFormat: JWT description: >- Access token JWT. Use as Authorization: Bearer . In the API playground, paste the JWT only. fluideApiKey: type: apiKey in: header name: X-Fluide-Api-Key description: >- Developer API key (fl_dev_...). Required on every API call with a machine access token. x-default: fl_dev_your_key fluideClientId: type: apiKey in: header name: X-Fluide-Client-Id description: >- First-party client audience. Must match the fluide_client_id claim on the JWT. Use fluide-developer for Connect. x-default: fluide-developer ````