Copy Page
Sokin Embedded API
Getting Started
Sokin Definitions
Guides
Authentication
Receiving Payments
FX Payments
Payments
Unfunded Payments
Unfunded FX Payments
Webhooks
Corporate Onboarding
Data Requirements
Step 1: Create a corporate profile
Step 2: Add associates
Step 3: Add a parent entity (if applicable)
Step 4: Upload company documents
Step 5: Upload associate documents
Real-time Status Updates via Webhook
Conditional Step: Upload Parent Entity documents (if applicable)
Step 6: Finalise onboarding submission
Uploading supporting documents using Pre-signed URLs
Onboarding Reference Data
Onboarding Models
Data-Only model
Supported Jurisdictions & National ID Requirements
Authentication
Get Token
Get Token on behalf of corporate
Schemas
TokenResponse
Corporates
v2025-12-01
Create a new Corporate
Add a parent entity (corporate associate) to an onboarding request
Add an associate to a corporate onboarding request
Request pre-signed URLs for onboarding document uploads
Request pre-signed URLs for parent entity document uploads
Request pre-signed URLs for associate document uploads
Finalise corporate onboarding submission
Schemas
AssociateIdentityType
AssociateDocumentPresignedUrlResponse
ApiResponse[AddParentEntityResponse]
CreateCorporateResponse
AddIndividualAssociateResponse
UboDetails
AddOnboardingDocumentsRequest
OwnershipType
CorporateDetailResponse
AddParentEntityRequest
MoneyRange
ErrorDetail
AddAssociateDocumentsRequest
PresignedUrlResponse
AddIndividualAssociateRequest
CorporateCategories
AddParentEntityDocumentsRequest
AddAssociateDocumentsResponse
AssociateDocumentPresignedUrlResponseItem
ApiResponse[AddOnboardingDocumentsResponse]
ErrorResponse
AddOnboardingDocumentsResponse
FinaliseSubmissionRequest
AddressTypeEnum
ApiResponse[CorporateDetailResponse]
MessageResponse
ApiResponse[CreateCorporateResponse]
NumericRange
CreateCorporateRequest
ApiResponse[AddAssociateDocumentsResponse]
AssociateType
CorporateAssociateType
ApiResponse[AddIndividualAssociateResponse]
AddParentEntityResponse
FinaliseSubmissionResponse
AssociateIdentityType
Corporate Currency Accounts
v2025-12-01
Get Corporate Currency Accounts
Get Corporate Currency Account By Reference
Schemas
GetCCAByReferenceResponse
GetCCAsResponseItem
PaginatedApiResponse[GetCCALedgerItemsResponseItem]
ErrorDetail
PageInfo
SearchCCALedgersResponseItem
PaginationInfo
GetCCAUnifiedBalanceResponse
PaginatedApiResponse[SearchCCALedgersResponseItem]
ErrorResponse
ApiResponse[GetCCAUnifiedBalanceResponse]
SearchCCALedgersRequest
PaginatedApiResponse[GetCCAsResponseItem]
ApiResponse[GetCCAByReferenceResponse]
PaginationInfo
SearchCCALedgersPagination
GetCCAByReferenceResponsePayInDetail
CurrencyCode
GetCCALedgerItemsResponseItem
PaginationInfo
Beneficiaries
v2025-12-01
Get Beneficiary Schema
Create Beneficiary
Get Beneficiary List
Get Beneficiary Details
Delete Beneficiary
Validate Beneficiary
List Financial Institutions
List Financial Institution Branches
Schemas
BeneficiaryValidationPayload
PaymentMethodType
PaymentRail
FinancialInstitutionReferenceResponse
ApiResponse[GetBeneficiarySchemaResponse]
ApiResponse[list[FinancialInstitutionReferenceResponse]]
DeleteBeneficiaryData
AddressResponse
ApiResponse[list[BankCountryCurrencyResponse]]
ErrorDetail
PageInfo
BeneficiaryValidationResultResponse
StateOrProvince
ApiResponse[ValidateBatchBeneficiariesResponse]
DestinationResponse
BeneficiaryField
BeneficiaryStatus
ValidationStatus
PaginationInfo
BeneficiaryType
FinancialInstitutionRequest
ValidateBeneficiariesRequest
ApiResponse[DeleteBeneficiaryData]
CompanyDetailsResponse
ValidateBeneficiaryRequest
FieldErrorResponse
StateOrProvince
PaginatedApiResponse[FinancialInstitutionBranchReferenceResponse]
CreateBeneficiaryRequest
VirtualAccountDestinationRequest
ErrorResponse
BankCountryCurrencyResponse
FieldType
CreateExternalBeneficiaryRequest
SokinInternalDestinationRequest
GetBeneficiaryFieldsResponse
BeneficiarySchemaField
BeneficiaryResponse
FinancialInstitutionBranchReferenceResponse
ApiResponse[BeneficiaryResponse]
IdentifierType
IndividualDetailsRequest
SchemaFieldType
ApiResponse[ValidateBeneficiaryResponse]
ValidateBeneficiaryResponse
TransactionTypeEnum
AccountType
ETransferDestinationRequest
AccountNumberType
BankAccountCategory
PaginatedApiResponse[BeneficiaryResponse]
ApiResponse[list[BankCountryResponse]]
AddressRequest
RegionalHints
BeneficiaryDestinationValidationResult
PaginationInfo
ValidateBatchBeneficiariesResponse
ApiResponse[GetBeneficiaryFieldsResponse]
BankAccountDestinationRequest
CreateExternalBeneficiaryData
GetBeneficiarySchemaResponse
ApiResponse[CreateExternalBeneficiaryData]
CompanyDetailsRequest
BankCountryResponse
CurrencyCode
IndividualDetailsResponse
BeneficiarySchemaCondition
BeneficiaryEntityType
RoutingCodeRequest
ApiResponse[BeneficiaryDetails]
BeneficiaryListItem
PaginatedApiResponse[BeneficiaryListItem]
StateOrProvince
PaginationInfo
PaginatedBeneficiaryFieldsResponse
BeneficiaryDetails
RoutingScheme
ApiResponse[ListFinancialInstitutionsResponse]
ListFinancialInstitutionsResponse
Instruction Requests
v2025-12-01
Create Payment Instruction Request
Create Fx Instruction Request
Create Fx Payment Instruction Request
Create Unfunded Payment Instruction Request
Create Unfunded Fx Payment Instruction Request
Get Instruction Request By Reference
Schemas
ApiResponse[GetInstructionRequestResponse]
ValidateInstructionCreationRequest
ErrorDetail
InstructionType
CreateInstructionRequestResponse
ApiResponse[CreateInstructionRequestResponse]
ValidateInstructionCreationResponse
CreateFxPaymentInstructionRequest
FeeBreakdownResponse
ErrorResponse
CreateUnfundedPaymentInstructionRequest
CreateUnfundedFxPaymentInstructionRequest
ApiResponse[list[str]]
GetInstructionRequestResponse
PaymentPurpose
CreatePaymentInstructionRequest
CreateFXInstructionRequest
ApiResponse[ValidateInstructionCreationResponse]
CreateSokinDirectInstructionRequest
Instructions
v2025-12-01
Get Instruction By Reference
Schemas
GetInstructionResponse
PaginatedApiResponse[InstructionListResponseItem]
ApiResponse[GetInstructionResponse]
PaginationInfo
ErrorResponse
ErrorDetail
PageInfo
InstructionListResponseItem
PaginationInfo
Foreign Exchange
v2025-12-01
Get Fx Rate
Schemas
ApiResponse[FxRateData]
FixedSide
FxRateRequest
FxRateData
ErrorResponse
ErrorDetail
Webhooks
v2025-12-01
Create Subscription
Update Subscription
Get Subscription By Id
Delete Subscription
Update Subscription Status
List Notification Logs
Retry Notification
Schemas
ApiResponse[UpdateSubscriptionResponse]
PaginationInfo
SubscriptionCreateOrUpdate
NotificationStatus
NotificationAttemptResponse
SubscribableWebhookEventType
SubscriptionStatusUpdate
ApiResponse[CreateSubscriptionResponse]
UpdateSubscriptionResponse
PaginatedApiResponse[NotificationLogResponse]
PaginationInfo
ErrorResponse
ErrorDetail
PageInfo
CreateSubscriptionResponse
NotificationLogResponse
WebhookSubscription
Payment Acceptance
Payment Acceptance
CreateExternalBeneficiaryData(CreateExternalBeneficiaryData)
Copy Page
Response data for external beneficiary creation.
Fields use snake_case internally but are serialized to camelCase via BaseApiResponseModel.
{
"beneficiaryId"
:
"string"
}