Sokin Embedded API
  1. v2025-12-01
Sokin Embedded API
  • Getting Started
    • Sokin Definitions
    • Guides
      • Authentication
      • Receiving Payments
      • FX Payments
      • Payments
      • Unfunded Payments
      • Unfunded FX Payments
  • Authentication
    • Get Token
      POST
    • Get Token on behalf of corporate
      POST
    • Schemas
      • TokenResponse
  • Corporates
    • v2025-12-01
      • Create a new Corporate
      • Request pre-signed URLs for onboarding document uploads
      • Add an individual associate to a corporate onboarding request
      • Finalise corporate onboarding submission
    • Schemas
      • FinaliseSubmissionResponse
      • PresignedUrlResponse
      • FinaliseSubmissionRequest
      • CreateCorporateResponse
      • CreateCorporateRequest
      • ApiResponse[CreateCorporateResponse]
      • AddOnboardingDocumentsRequest
  • Corporate Currency Accounts
    • v2025-12-01
      • Get Corporate Currency Accounts
      • Get Corporate Currency Account By Reference
    • Schemas
      • ErrorResponse
      • PaginationInfo
      • ErrorDetail
      • ApiResponse[GetCCAByReferenceResponse]
      • GetCCAByReferenceResponse
      • GetCCAByReferenceResponsePayInDetail
      • GetCCAsResponseItem
      • PaginatedApiResponse[GetCCAsResponseItem]
  • Beneficiaries
    • v2025-12-01
      • Get Beneficiary Fields
        GET
      • Create External Beneficiary
        POST
      • Get Beneficiary List
        GET
      • Get Beneficiary Details
        GET
      • Delete Beneficiary
        DELETE
    • Schemas
      • ApiResponse[BeneficiaryDetails]
      • ApiResponse[CreateExternalBeneficiaryData]
      • ApiResponse[GetBeneficiaryFieldsResponse]
      • StateOrProvince
      • PaginatedApiResponse[BeneficiaryListItem]
      • GetBeneficiaryFieldsResponse
      • ApiResponse[DeleteBeneficiaryData]
      • BeneficiaryField
      • BeneficiaryListItem
      • CreateExternalBeneficiaryData
      • CreateExternalBeneficiaryRequest
      • DeleteBeneficiaryData
      • PaginatedBeneficiaryFieldsResponse
  • Instruction Requests
    • v2025-12-01
      • Get Instruction Request By Reference
      • Create Payment Instruction Request
      • Create Fx Instruction Request
      • Create Fx Payment Instruction Request
      • Create Unfunded Payment Instruction Request
      • Create Unfunded Fx Payment Instruction Request
    • Schemas
      • ErrorResponse
      • ApiResponse[CreateInstructionRequestResponse]
      • ErrorDetail
      • ApiResponse[GetInstructionRequestResponse]
      • CreateFxPaymentInstructionRequest
      • CreateInstructionRequestResponse
      • CreatePaymentInstructionRequest
      • CreateUnfundedFxPaymentInstructionRequest
      • CreateUnfundedPaymentInstructionRequest
      • GetInstructionRequestResponse
      • CreateFXInstructionRequest
  • 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 Status
      • Update Subscription
      • Delete Subscription
      • Get Subscription By Id
      • List Notification Logs
      • Retry Notification
    • Schemas
      • ApiResponse[CreateSubscriptionResponse]
      • NotificationStatus
      • ApiResponse[NotificationLogList]
      • NotificationAttemptResponse
      • ApiResponse[UpdateSubscriptionResponse]
      • NotificationLogList
      • ErrorResponse
      • NotificationLogResponse
      • SubscriptionCreateOrUpdate
      • SubscriptionStatusUpdate
      • CreateSubscriptionResponse
      • UpdateSubscriptionResponse
      • InstructionCreated
      • ErrorDetail
      • InstructionReqeustRejected
      • InstructionProcessedWebhook
      • InstructionRejectedWebhook
      • OnboardingRequestApproved
      • OnboardingRequestRejected
      • CorporateActivated
      • CorporateDeactivated
      • CorporateCurrencyAccountFundingReceived
      • WebhookSubscription
      • WebhookNotificationLogs
  1. v2025-12-01

Get Beneficiary Details

Testing Env
https://api.uat.sokin.com
Testing Env
https://api.uat.sokin.com
GET
/beneficiaries/{beneficiary_id}
Get beneficiary details by ID.

Request

Path Params

Query Params

Header Params

Responses

🟢200
application/json
Successful Response
Body

🟠400
🟠401
🟠403
🟠404
🟠422
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.uat.sokin.com/beneficiaries/?beneficiaryType' \
--header 'x-api-version;'
Response Response Example
200 - Example 1
{
    "message": "string",
    "data": {
        "id": "string",
        "beneficiaryId": "string",
        "beneficiarySokinCorporateCode": "string",
        "beneficiaryCorporateName": "string",
        "corporateCode": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "beneficiaryName": "string",
        "beneficiaryType": "string",
        "accountName": "string",
        "accountType": "string",
        "accountNumber": "string",
        "identifierType": "string",
        "identifierCode": "string",
        "addressLineOne": "string",
        "addressLineTwo": "string",
        "addressLineThree": "string",
        "postalCode": "string",
        "city": "string",
        "currencyCode": "string",
        "countryName": "string",
        "countryCode": "string",
        "beneficiaryNameChinese": "string",
        "payeeIdNumber": "string",
        "payeeMobileNumber": "string",
        "bankName": "string",
        "bankNameChinese": "string",
        "province": "string",
        "provinceChinese": "string",
        "cityChinese": "string"
    }
}
Modified at 2025-12-17 17:47:25
Previous
Get Beneficiary List
Next
Delete Beneficiary
Built with