{"openapi":"3.0.3","info":{"version":"3.0","title":"Company","description":"It deals with all  company operations and user management api ","x-logo":{"url":""}},"paths":{"/sub-accounts/{subCompanyId}/login":{"post":{"summary":"Sub-Account Login","tags":["Subaccount"],"operationId":"subaccount_login","x-atlas-api":true,"x-permission-config":["Client:Sub-Accounts:write"],"parameters":[{"in":"path","name":"subCompanyId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"returns subaccount token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubAccountLoginRs"}}}},"400":{"description":"unacceptable request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/401Unauthorized"}}}},"403":{"description":"Forbidden when subaccount onboarding is rejected or company is archived","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"A server side error occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/sub-accounts/{subCompanyId}/tnc/send-email":{"post":{"x-atlas-api":true,"summary":"Send T&C email","description":"Trigger a Terms & Conditions acceptance email to the nominated director of a PARTNER_REFERRED sub-account. This endpoint is used as part of the Atlas for Platform onboarding flow, after all KYB data and documents have been submitted and the sub-account has been compliance-approved by Verto.","operationId":"trigger_email_to_subclient_director","x-permission-config":["Client:Sub-Accounts:write","Admin:Onboarding:read"],"tags":["Sub-Account"],"parameters":[{"name":"subCompanyId","description":"Company ID of the sub-account whose director should receive the email","in":"path","required":true,"schema":{"type":"number"}}],"requestBody":{"description":"Details of the director the Terms & Conditions email should be sent to","required":true,"content":{"application/json":{"schema":{"type":"object","required":["email","shareholderId"],"properties":{"email":{"type":"string","format":"email","description":"Email address the Terms & Conditions link will be sent to","example":"director@example.com"},"shareholderId":{"type":"string","description":"ID of the shareholder to email. Must be an active, UBO-approved director (controlling officer) of the sub-account. Obtained from the `shareholders` list returned by `GET /companies/{companyId}/onboarding-data` on the onboarding service, using the sub-account's company ID.","example":"a91ecbb5-2ea5-4424-87e6-1337d19ad1dc"}}}}}},"responses":{"200":{"description":"Email was sent and the sub-account's linked status was updated to pending acceptance","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Email sent successfully"}}}}},"400":{"description":"The selected shareholder exists but is not a director (controlling officer) of the sub-account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/401Unauthorized"}}}},"404":{"description":"Sub-account not found, or shareholderId does not match an active, UBO-approved director of the sub-account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"A server side error occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token returned by the Login endpoint. Send it as:\n> Authorization: Bearer <token>\n"}},"schemas":{"SubAccountLoginRs":{"type":"object","properties":{"userId":{"type":"string"},"companyId":{"type":"string"},"jwt":{"type":"string"}}},"Error":{"required":["message","code"],"type":"object","properties":{"message":{"description":"The error message indicating what the issue is","type":"string"},"code":{"description":"The error code","maximum":1000,"minimum":1,"type":"integer"}},"example":{"code":400,"message":"wrong input"}},"401Unauthorized":{"required":["message","success"],"type":"object","properties":{"message":{"description":"The request lacks valid authentication credentials. Please ensure you have the necessary authorization tokens and try again.","type":"string"},"success":{"description":"Success status of api","type":"boolean"}},"example":{"success":false,"message":"Unauthorized"}}}},"security":[{"bearerAuth":[]}],"servers":[{"url":"https://api-company-beta.vertofx.com"},{"url":"https://api-company-sandbox.vertofx.com"}]}