Skip to main content
POST
https://sandbox.finhub.cloud
/
api
/
v2.1
/
customer
/
organization
/
{organizationId}
/
activation
Organization Activation API
curl --request POST \
  --url https://sandbox.finhub.cloud/api/v2.1/customer/organization/{organizationId}/activation \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --header 'X-Tenant-ID: <x-tenant-id>' \
  --header 'X-User-ID: <x-user-id>' \
  --header 'X-User-Roles: <x-user-roles>' \
  --data '
{
  "activationReason": "<string>",
  "additionalInfo": {
    "testRun": true,
    "activatedBy": "<string>"
  }
}
'
{
  "code": 200,
  "message": "Organization activated successfully",
  "data": {
    "wallet": {
      "walletId": "49a2fe3a-a9df-48dc-9da3-e9dff8eb4968",
      "balance": "0.00",
      "currency": "EUR",
      "id": "49a2fe3a-a9df-48dc-9da3-e9dff8eb4968",
      "status": "ACTIVE"
    },
    "iban": "LT963500070344952515",
    "activation": {
      "message": "Organization activated successfully",
      "status": "ACTIVE",
      "activatedAt": "2026-01-13T10:04:12.830711352",
      "warnings": [
        "No employees found - consider adding employees with required roles"
      ]
    }
  }
}

Organization Activation API

Activate a verified organization account to enable wallet operations and financial transactions.
For complete details on authentication and headers, refer to the Standard HTTP Headers reference documentation.
Role Requirement: Only users with COMPLIANCE_OFFICER or ADMIN_USER roles can activate an organization.

Prerequisites Checklist (14-Step Validation)

Before attempting activation, the system validates 14 prerequisites:

1. Organization Structure (4 checks)

  • Organization registered and status = PENDING_ACTIVATION
  • At least 1 director added
  • At least 1 employee with ADMIN_USER role
  • Total shareholder ownership = 100% exactly

2. Verification (3 checks)

  • KYB verification completed
  • Verification status = APPROVED
  • All personnel (directors, UBOs) verified

3. Consents (3 checks)

  • Terms and Conditions accepted
  • Privacy Policy accepted
  • Data Processing Agreement accepted

4. Documents (2 checks)

  • All required corporate documents uploaded
  • All documents status = VERIFIED

5. Authorization (2 checks)

  • User has COMPLIANCE_OFFICER or ADMIN_USER role
  • User is linked to the organization
Check Activation Readiness: Use GET /{organizationId}/activation/readiness to validate all prerequisites before attempting activation.

Endpoint

POST /api/v2.1/customer/organization/{organizationId}/activation

Headers

X-Tenant-ID
string
required
Tenant identifierExample: tenant_cloudvault
Authorization
string
required
Bearer token for authentication (admin privileges required)
X-User-ID
string
required
User ID of the admin performing activationExample: e2f3a4b5-c6d7-48e9-0f1a-2b3c4d5e6f7a
X-User-Roles
string
required
Comma-separated list of user rolesExample: ADMIN_USER,COMPLIANCE_OFFICER
Content-Type
string
required
Must be application/json

Path Parameters

organizationId
string
required
Organization UUID identifierExample: ef4a8be6-602b-4b26-b81d-afa7d6d835fd

Request Body

activationReason
string
required
Reason for activationExample: "Organization account activation after KYB completion"
additionalInfo
object
Optional metadata about the activation

Code Examples

curl -X POST "https://sandbox.finhub.cloud/api/v2.1/customer/organization/ef4a8be6-602b-4b26-b81d-afa7d6d835fd/activation" \
  -H "X-Tenant-ID: tenant_cloudvault" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-User-ID: e2f3a4b5-c6d7-48e9-0f1a-2b3c4d5e6f7a" \
  -H "X-User-Roles: ADMIN_USER,COMPLIANCE_OFFICER" \
  -H "Content-Type: application/json" \
  -d '{
    "activationReason": "Organization account activation after KYB completion",
    "additionalInfo": {
      "testRun": false,
      "activatedBy": "Admin User"
    }
  }'

Response

{
  "code": 200,
  "message": "Organization activated successfully",
  "data": {
    "wallet": {
      "walletId": "49a2fe3a-a9df-48dc-9da3-e9dff8eb4968",
      "balance": "0.00",
      "currency": "EUR",
      "id": "49a2fe3a-a9df-48dc-9da3-e9dff8eb4968",
      "status": "ACTIVE"
    },
    "iban": "LT963500070344952515",
    "activation": {
      "message": "Organization activated successfully",
      "status": "ACTIVE",
      "activatedAt": "2026-01-13T10:04:12.830711352",
      "warnings": [
        "No employees found - consider adding employees with required roles"
      ]
    }
  }
}

Response Fields

code
integer
HTTP status code
message
string
Human-readable status message
data
object
Activation result data

Common Activation Warnings

The API may return warnings in the activation response. These warnings do not prevent activation but indicate configuration issues that should be addressed:
WarningMeaningAction Required
No employees found - consider adding employees with required rolesOrganization has no employeesAdd employees for production use
Missing ADMIN_USER role employeeNo employee with ADMIN_USER roleAdd employee with ADMIN_USER role immediately
No directors foundOrganization has no directorsAdd at least one director
Shareholder ownership does not sum to 100%Incomplete ownership structureReview shareholder percentages
Production ReadinessWhile warnings do not prevent activation, organizations should address all warnings before production use to ensure proper governance and compliance.

Organization vs Individual Activation

Key differences between organization and individual activation:
AspectIndividualOrganization
Request Bodycode, userIdactivationReason, additionalInfo
Verification MethodEmail verification codeAdmin-initiated after KYB
Response WarningsNo warningsMay include structural warnings
Required HeadersStandard authX-User-ID, X-User-Roles required
PrerequisitesKYC, ConsentsKYB, Consents, Team Structure

Post-Activation Operations

After successful activation, the organization can:
  1. Check Balance
    GET /api/v2.1/fintrans/{walletId}/balance
    
  2. Add Beneficiaries
    POST /api/v2.1/fintrans/{walletId}/beneficiaries
    
  3. Prepare Transactions
    POST /api/v2.1/fintrans/{walletId}/types/topup/prepare
    POST /api/v2.1/transfers/{walletId}/prepare
    
  4. Execute Transactions
    POST /api/v2.1/fintrans/{walletId}/types/topup/execute
    
See Financial Operations for complete transaction workflows.

Troubleshooting

Verification Not Completed

Error:
{
  "code": 400,
  "message": "Organization verification not completed"
}
Solution: Ensure KYB verification is completed and approved before activation.

Missing Consents

Error:
{
  "code": 400,
  "message": "Required consents not accepted"
}
Solution: Accept all three required consents:
  • Terms and Conditions: POST /consents/terms
  • Privacy Policy: POST /consents/privacy
  • Data Processing: POST /consents/data-processing

Missing ADMIN_USER Role

Error:
{
  "code": 400,
  "message": "Organization must have at least one employee with ADMIN_USER role"
}
Solution: Add an employee with ADMIN_USER role before activation.

What Happens During Activation

When activation is successful, the system performs these 6 automatic actions:
StepActionDetails
1Status UpdateOrganization status changes from PENDING_ACTIVATIONACTIVE
2Wallet ActivationDefault EUR wallet created and activated
3IBAN/BIC AssignmentUnique IBAN and BIC assigned to organization account
4Category Limits AppliedTransaction limits based on categorization (daily, monthly, per-txn)
5Features EnabledCategory features activated (transfers, payments, topups)
6Audit TrailComplete activation log created with timestamps and user info

What Happens After Activation

Once activated, the organization can: Financial Operations:
  • Check wallet balance
  • Add beneficiaries
  • Create payment consents
  • Execute transfers (SEPA, SWIFT)
  • Top up wallet
Account Management:
  • Add more employees/directors
  • Update organization details
  • Upload additional documents

Wallet Information

After activation, the organization receives a default EUR wallet:
AttributeValueDescription
CurrencyEURDefault currency
StatusACTIVEReady for transactions
Balance0.00Initial balance
IBANDE89370400440532013000Unique account number
BICCOBADEFFXXXBank identifier code
Account TypeBUSINESSBusiness account

API Schema Reference

For the complete OpenAPI schema specification, see the API Schema Mapping document.

Changelog

VersionDateChanges
v1.02026-01-13Comprehensive organization activation documentation