Copy Page
Sokin Embedded API
Getting Started
Sokin Definitions
Guides
Authentication
Receiving Payments
FX Payments
Payments
Unfunded Payments
Unfunded FX Payments
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
NumericRange
ApiResponse[AddIndividualAssociateResponse]
ApiResponse[AddAssociateDocumentsResponse]
ApiResponse[AddOnboardingDocumentsResponse]
AddOnboardingDocumentsResponse
AssociateDocumentPresignedUrlResponse
AssociateType
ErrorResponse
MessageResponse
FinaliseSubmissionResponse
AddParentEntityRequest
MoneyRange
AddOnboardingDocumentsRequest
ApiResponse[CreateCorporateResponse]
CreateCorporateRequest
CreateCorporateResponse
FinaliseSubmissionRequest
PresignedUrlResponse
AddressTypeEnum
OwnershipType
AddAssociateDocumentsResponse
ErrorDetail
AddIndividualAssociateRequest
UboDetails
AddParentEntityResponse
AddIndividualAssociateResponse
CorporateAssociateType
AddParentEntityDocumentsRequest
AssociateDocumentPresignedUrlResponseItem
ApiResponse[AddParentEntityResponse]
AssociateIdentityType
AddAssociateDocumentsRequest
Corporate Currency Accounts
v2025-12-01
Get Corporate Currency Accounts
Get Corporate Currency Account By Reference
Schemas
PaginatedApiResponse[GetCCALedgerItemsResponseItem]
ErrorResponse
GetCCALedgerItemsResponseItem
PaginationInfo
ErrorDetail
ApiResponse[GetCCAByReferenceResponse]
GetCCAByReferenceResponse
GetCCAByReferenceResponsePayInDetail
GetCCAsResponseItem
PaginatedApiResponse[GetCCAsResponseItem]
Beneficiaries
v2025-12-01
Get Beneficiary List
Get Beneficiary Details
Delete Beneficiary
List Financial Institutions
List Financial Institution Branches
Get Beneficiary Fields
Create External Beneficiary
Schemas
DestinationResponse
ErrorResponse
FieldType
PaymentMethodType
IdentifierType
AccountNumberType
TransactionTypeEnum
CompanyDetailsRequest
BeneficiaryType
RoutingCodeRequest
PaginatedApiResponse[FinancialInstitutionBranchReferenceResponse]
AccountType
ApiResponse[BeneficiaryDetails]
ApiResponse[CreateExternalBeneficiaryData]
ApiResponse[DeleteBeneficiaryData]
ApiResponse[GetBeneficiaryFieldsResponse]
BeneficiaryField
BeneficiaryListItem
CreateExternalBeneficiaryData
CreateExternalBeneficiaryRequest
DeleteBeneficiaryData
GetBeneficiaryFieldsResponse
PaginatedApiResponse[BeneficiaryListItem]
StateOrProvince
AddressRequest
PaginationInfo
PaginationInfo
FinancialInstitutionReferenceResponse
PaginatedBeneficiaryFieldsResponse
GetBeneficiarySchemaResponse
VirtualAccountDestinationRequest
BeneficiarySchemaCondition
ErrorDetail
StateOrProvince
FinancialInstitutionRequest
BankAccountDestinationRequest
BeneficiaryDetails
CreateBeneficiaryRequest
ETransferDestinationRequest
StateOrProvince
BeneficiaryEntityType
RegionalHints
SchemaFieldType
BeneficiarySchemaField
RoutingScheme
CompanyDetailsResponse
PaymentRail
ApiResponse[BeneficiaryResponse]
BankAccountCategory
ApiResponse[ListFinancialInstitutionsResponse]
SokinInternalDestinationRequest
IndividualDetailsResponse
PageInfo
AddressResponse
BeneficiaryResponse
FinancialInstitutionBranchReferenceResponse
ListFinancialInstitutionsResponse
IndividualDetailsRequest
BeneficiaryStatus
PaginatedApiResponse[BeneficiaryResponse]
PaginationInfo
ApiResponse[GetBeneficiarySchemaResponse]
ApiResponse[list[FinancialInstitutionReferenceResponse]]
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
ErrorResponse
ApiResponse[CreateInstructionRequestResponse]
ErrorDetail
ApiResponse[GetInstructionRequestResponse]
CreateFXInstructionRequest
CreateFxPaymentInstructionRequest
CreateInstructionRequestResponse
CreatePaymentInstructionRequest
CreateUnfundedFxPaymentInstructionRequest
CreateUnfundedPaymentInstructionRequest
GetInstructionRequestResponse
Instructions
v2025-12-01
Get Instruction By Reference
Schemas
ErrorDetail
ErrorResponse
ApiResponse[GetInstructionResponse]
GetInstructionResponse
Foreign Exchange
v2025-12-01
Get Fx Rate
Schemas
ErrorResponse
FxRateData
FixedSide
ApiResponse[FxRateData]
ErrorDetail
FxRateRequest
Webhooks
Webhooks
v2025-12-01
Create Subscription
Update Subscription
Update Subscription Status
Get Subscription By Id
Delete Subscription
Retry Notification
List Notification Logs
Schemas
PaginatedApiResponse[NotificationLogResponse]
ApiResponse[CreateSubscriptionResponse]
NotificationStatus
ApiResponse[NotificationLogList]
NotificationAttemptResponse
NotificationLogList
ApiResponse[UpdateSubscriptionResponse]
ErrorResponse
NotificationLogResponse
SubscriptionCreateOrUpdate
SubscriptionStatusUpdate
CreateSubscriptionResponse
UpdateSubscriptionResponse
InstructionCreated
PaginationInfo
ErrorDetail
InstructionReqeustRejected
InstructionProcessedWebhook
InstructionRejectedWebhook
OnboardingRequestApproved
OnboardingRequestRejected
CorporateActivated
CorporateDeactivated
CorporateCurrencyAccountFundingReceived
WebhookSubscription
WebhookNotificationLogs
VirtualAccountDestinationRequest(VirtualAccountDestinationRequest)
Copy Page
{
"providerCode"
:
"string"
,
"accountNumber"
:
"string"
,
"accountName"
:
"string"
}