oceafin
    • Oceafin Partner API V1
    • Getting Started
    • Authentication
    • Customers And Onboarding
    • Product Workflows
    • Webhooks
    • Errors
    • Partner Customers
      • Create partner customer
        POST
      • Upload or link a file to a partner customer
        POST
      • Submit partner-attested KYC or KYB evidence
        POST
      • List partner customer balances
        GET
      • List partner customer transactions
        GET
      • Get partner transaction
        GET
    • Partner Conversion
      • List partner conversion quotes
        GET
      • Create partner conversion quote
        POST
      • Get partner conversion quote
        GET
      • List partner conversions
        GET
      • Create partner conversion approval draft
        POST
      • Get partner conversion
        GET
    • Partner Fiat
      • Get partner fiat account capabilities
        GET
      • Create partner fiat account application
        POST
      • Submit additional information for a partner fiat account application
        POST
      • List partner fiat accounts
        GET
      • Get partner fiat deposit instructions
        GET
      • List partner fiat deposits
        GET
      • Get partner fiat deposit
        GET
      • List partner bank accounts
        GET
      • Create partner bank account
        POST
      • Get partner fiat withdrawal capabilities
        GET
      • Activate partner fiat withdrawal capability
        POST
      • Submit fiat withdrawal capability activation additional information
        POST
      • Create partner fiat withdrawal quote
        POST
      • Create partner fiat withdrawal approval draft
        POST
      • List partner fiat withdrawals
        GET
      • Submit an approved partner fiat withdrawal for processing
        POST
      • Submit additional information for a partner fiat withdrawal
        POST
      • Get partner fiat withdrawal
        GET
    • Partner Crypto
      • List partner crypto deposit wallets
      • List partner crypto deposits
      • Get partner crypto deposit
      • Submit partner crypto deposit Travel Rule information
      • Create partner crypto withdrawal quote
      • List partner crypto wallet beneficiaries
      • Create partner crypto wallet beneficiary
      • Get partner crypto wallet beneficiary
      • Remove partner crypto wallet beneficiary
      • Sync partner crypto wallet beneficiary
      • Create partner crypto withdrawal approval draft
      • List partner crypto withdrawals
      • Submit an approved partner crypto withdrawal for processing
      • Get partner crypto withdrawal
      • List partner crypto refunds
      • Create partner crypto refund approval draft
      • Get partner crypto refund
      • Submit an approved partner crypto refund for processing
      • Confirm partner crypto refund
      • List partner crypto checkouts
      • Create partner crypto checkout
      • Get partner crypto checkout
      • Create partner checkout link
      • Create partner checkout POS payment request
      • Close partner crypto checkout
      • List partner collection buyers
      • Create partner collection buyer
      • Get partner collection buyer
      • Update partner collection buyer
      • List partner collection wallets
      • Create partner collection wallet
      • Get partner collection wallet
      • Update partner collection wallet expiry
      • Deactivate partner collection wallet
      • List partner collection payments
      • Get partner collection payment
    • Schemas
      • CreatePartnerCustomerRequest
      • PartnerCustomerType
      • PartnerCustomerStatus
      • PartnerCustomer
      • LinkPartnerCustomerFileRequest
      • UploadPartnerCustomerFileRequest
      • PartnerCustomerFile
      • PartnerOnboardingSubmissionRequest
      • PartnerOnboardingEvidenceSubmission
      • PartnerIndividualKycSubmission
      • PartnerKycPersonalDetails
      • PartnerKycAdditionalPersonalDetails
      • PartnerCorporateKybSubmission
      • PartnerKybCorporationDetails
      • PartnerKybAdditionalCorporationDetails
      • PartnerOnboardingSupportingDocument
      • PartnerOnboardingAddress
      • PartnerOnboardingContactNumber
      • PartnerOnboardingContactPerson
      • PartnerOnboardingKeyPerson
      • PartnerOnboardingSubmission
      • PartnerBalancePage
      • PartnerBalance
      • PartnerTransactionPage
      • PartnerTransaction
      • CreatePartnerFiatAccountApplicationRequest
      • SubmitPartnerFiatAccountAdditionalInfoRequest
      • PartnerFiatCapabilities
      • PartnerFiatCapabilitiesData
      • PartnerFiatCapabilityRoute
      • PartnerFiatAccountApplication
      • PartnerFiatAccountPage
      • PartnerFiatAccount
      • PartnerFiatAccountBankDetails
      • PartnerFiatDepositInstructions
      • PartnerFiatDepositInstruction
      • PartnerFiatDepositPage
      • PartnerFiatDeposit
      • PartnerCryptoDepositWalletPage
      • PartnerCryptoDepositWallet
      • PartnerCryptoDepositPage
      • PartnerCryptoDeposit
      • SubmitPartnerCryptoTravelRuleInfoRequest
      • PartnerCryptoTravelRuleInfo
      • CreatePartnerCryptoWithdrawalQuoteRequest
      • PartnerCryptoWithdrawalQuote
      • CreatePartnerWalletBeneficiaryRequest
      • PartnerWalletBeneficiarySupportFile
      • PartnerCryptoWalletBeneficiaryActionRequest
      • PartnerWalletBeneficiaryPage
      • PartnerWalletBeneficiary
      • CreatePartnerCryptoWithdrawalRequest
      • SubmitPartnerCryptoWithdrawalRequest
      • PartnerCryptoWithdrawalPage
      • PartnerCryptoWithdrawal
      • CreatePartnerCryptoRefundRequest
      • SubmitPartnerCryptoRefundRequest
      • PartnerCryptoRefundPage
      • PartnerCryptoRefund
      • CreatePartnerConversionQuoteRequest
      • CreatePartnerConversionRequest
      • PartnerConversionQuotePage
      • PartnerConversionQuote
      • PartnerConversionPage
      • PartnerConversion
      • CreatePartnerCheckoutRequest
      • PartnerCheckoutPage
      • PartnerCheckout
      • CreatePartnerCheckoutLinkRequest
      • PartnerCheckoutLink
      • CreatePartnerCheckoutPosPaymentRequest
      • PartnerCheckoutPosPaymentRequest
      • PartnerCheckoutActionRequest
      • CreatePartnerBuyerRequest
      • UpdatePartnerBuyerRequest
      • PartnerBuyerDocument
      • PartnerBuyerPage
      • PartnerBuyer
      • CreatePartnerCollectionWalletRequest
      • UpdatePartnerCollectionWalletExpiryRequest
      • PartnerCollectionWalletActionRequest
      • PartnerCollectionWalletPage
      • PartnerCollectionWallet
      • PartnerCollectionWalletAddress
      • PartnerCollectionPaymentPage
      • PartnerCollectionPayment
      • CreatePartnerBankAccountRequest
      • PartnerBankAccountThirdPartyBeneficiary
      • PartnerBankAccountThirdPartyAddress
      • PartnerBankAccountPage
      • PartnerBankAccount
      • PartnerFiatWithdrawalCapabilities
      • PartnerFiatWithdrawalCapabilitiesData
      • PartnerFiatWithdrawalCapabilityRoute
      • ActivatePartnerFiatWithdrawalCapabilityRequest
      • SubmitPartnerFiatWithdrawalCapabilityAdditionalInfoRequest
      • PartnerFiatWithdrawalCapabilityActivation
      • CreatePartnerFiatWithdrawalQuoteRequest
      • PartnerFiatWithdrawalQuote
      • PartnerBalanceAvailability
      • CreatePartnerFiatWithdrawalRequest
      • SubmitPartnerFiatWithdrawalRequest
      • SubmitPartnerFiatWithdrawalAdditionalInfoRequest
      • PartnerFiatWithdrawalAdditionalInfo
      • PartnerFiatWithdrawalPage
      • PartnerFiatWithdrawal
      • PartnerOperationAuthorizationEvidence
      • PageInfo
      • PartnerProblem
      • PartnerProblemCode

    Customers And Onboarding

    Customer Model#

    A Customer is the partner's end user in Oceafin.
    External identifiers:
    partnerCustomerRef: partner-owned stable customer reference.
    customerId: Oceafin-generated public id returned by the Partner API.
    Partners must not send:
    tenant id
    business id
    merchant id
    internal processing identifiers
    internal file identifiers
    raw processing payload fields

    Customer Statuses#

    StatusMeaning
    DRAFTCustomer exists but onboarding has not been submitted.
    SUBMITTEDOnboarding was accepted by Oceafin for processing.
    PROCESSINGOnboarding or product processing is in progress.
    MISSING_INFO_REQUIREDAdditional data or files are required.
    APPROVEDCustomer is approved for enabled product workflows.
    REJECTEDCustomer onboarding was rejected.
    SUSPENDEDCustomer is suspended by platform controls.
    CLOSEDCustomer relationship is closed.

    Create Customer#

    Request:
    {
      "partnerCustomerRef": "cust-100001",
      "customerType": "INDIVIDUAL",
      "displayName": "Jane Partner",
      "metadata": {
        "sourceSystem": "partner-crm"
      }
    }
    customerType is INDIVIDUAL or CORPORATE.
    Creating a Customer does not submit KYC or KYB. It creates the partner-visible
    customer record used by later onboarding and product calls.

    Upload Or Link Files#

    The endpoint accepts either:
    multipart/form-data with a binary file.
    application/json linking an existing file asset id returned by an approved
    file flow.
    Partners must reference the returned fileAssetId in onboarding submissions.
    Partners must not send internal file identifiers.

    Submit KYC Or KYB#

    Common request sections:
    customerType
    consentEvidence
    partnerAttestation
    fileAssetIds
    submission
    For individual KYC, submission includes:
    personalDetails
    additionalPersonalDetails
    supportingDocuments
    For corporate KYB, submission includes:
    corporationDetails
    additionalCorporationDetails
    supportingDocuments
    Each supporting document must reference a fileAssetId that was uploaded or
    linked through the Partner file endpoint.

    Consent Evidence#

    Consent evidence records what the partner displayed and captured from the end
    user. Recommended fields:
    termsVersion
    privacyVersion
    dataSharingVersion
    displayedAt
    acceptedAt
    acceptedByPartnerUserRef
    ipAddress
    userAgent
    locale
    evidenceHash

    Partner Attestation#

    Partner attestation records that the partner collected the data and is authorized
    to submit it to Oceafin. Recommended fields:
    attestedAt
    attestedByClientId
    collectionChannel
    sourceSystem
    sourceRecordRef
    dataHash
    fileBundleHash
    attestedByClientId must match X-Partner-Client-Id.
    Modified at 2026-06-28 01:20:12
    Previous
    Authentication
    Next
    Product Workflows
    Built with