Customer Model#
A Customer is the partner's end user in Oceafin.partnerCustomerRef: partner-owned stable customer reference.
customerId: Oceafin-generated public id returned by the Partner API.
internal processing identifiers
internal file identifiers
raw processing payload fields
Customer Statuses#
| Status | Meaning |
|---|
DRAFT | Customer exists but onboarding has not been submitted. |
SUBMITTED | Onboarding was accepted by Oceafin for processing. |
PROCESSING | Onboarding or product processing is in progress. |
MISSING_INFO_REQUIRED | Additional data or files are required. |
APPROVED | Customer is approved for enabled product workflows. |
REJECTED | Customer onboarding was rejected. |
SUSPENDED | Customer is suspended by platform controls. |
CLOSED | Customer relationship is closed. |
Create Customer#
{
"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#
For individual KYC, submission includes:additionalPersonalDetails
For corporate KYB, submission includes:additionalCorporationDetails
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:Partner Attestation#
Partner attestation records that the partner collected the data and is authorized
to submit it to Oceafin. Recommended fields:attestedByClientId must match X-Partner-Client-Id.Modified at 2026-06-28 01:20:12