- 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
- Authentication
- 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
- v2025-12-01
- Corporate Currency Accounts
- Beneficiaries
- v2025-12-01
- 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
- BeneficiaryValidationPayload
- CompanyDetailsResponse
- PaymentRail
- ApiResponse[BeneficiaryResponse]
- BankAccountCategory
- ApiResponse[ListFinancialInstitutionsResponse]
- ValidateBeneficiariesRequest
- SokinInternalDestinationRequest
- IndividualDetailsResponse
- PageInfo
- AddressResponse
- BeneficiaryResponse
- FinancialInstitutionBranchReferenceResponse
- ListFinancialInstitutionsResponse
- ValidateBatchBeneficiariesResponse
- IndividualDetailsRequest
- CurrencyCode
- BeneficiaryStatus
- PaginatedApiResponse[BeneficiaryResponse]
- PaginationInfo
- ApiResponse[ValidateBatchBeneficiariesResponse]
- ApiResponse[GetBeneficiarySchemaResponse]
- ApiResponse[list[FinancialInstitutionReferenceResponse]]
- BeneficiaryValidationResultResponse
- FieldErrorResponse
- Instruction Requests
- v2025-12-01
- Schemas
- ErrorResponse
- ApiResponse[CreateInstructionRequestResponse]
- ErrorDetail
- ApiResponse[GetInstructionRequestResponse]
- CreateFXInstructionRequest
- CreateFxPaymentInstructionRequest
- CreateInstructionRequestResponse
- CreatePaymentInstructionRequest
- CreateUnfundedFxPaymentInstructionRequest
- CreateUnfundedPaymentInstructionRequest
- GetInstructionRequestResponse
- Instructions
- Foreign Exchange
- Webhooks
- Webhooks
- v2025-12-01
- 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
BeneficiaryValidationPayload(BeneficiaryValidationPayload)
as dict so that invalid values are passed through to the validator rather than rejected at
request parsing time.
{
"reference": "string",
"displayName": "string",
"entityType": "string",
"countryCode": "string",
"currencyCode": "string",
"paymentRail": "string",
"bankAccount": {},
"eTransfer": {},
"virtualAccount": {},
"sokinInternal": {},
"individual": {},
"company": {},
"address": {},
"providerMetadata": {
"property1": "string",
"property2": "string"
},
"property1": "string",
"property2": "string"
}