Onboarding Quick Reference
Every field, document type, position, and status code used across the Merchant Acquiring Reseller onboarding flow, plus operational and security reminders.
Part of Merchant Acquiring Reseller — quick lookupA single-page reference for the document types, position types, business types, and status codes used throughout the 20-step flow, followed by the operational and security reminders that apply across every step.
Field, document, and code quick reference
Document types — at the customer level
NATIONAL_IDENTITY · BACK_OF_NATIONAL_IDENTITY · PASSPORT · DRIVERS_LICENSE · BACK_OF_DRIVERS_LICENSE · TEMPORARY_IDENTITY · TEMPORARY_IDENTITY_RECEIPT · BIRTH_CERTIFICATE · FACIAL_PHOTO · ENHANCED_DUE_DILIGENCE · ASYLUM_PAPERS · VISA · WORK_PERMIT · TEMP_RESIDENCY_PERMIT · PERMIT · PROOF_OF_ADDRESS · BANK_STATEMENT · PROOF_OF_FUNDS · TAX · AFFIDAVIT · FOREIGN_CERTIFICATE
Document types — at the organisation level
CERT_OF_INCORP · CERT_OF_REGISTRATION · PROOF_OF_ADDRESS · TAX · BANK_ACCOUNT_CONFIRMATION · BANK_STATEMENT · BUSINESS_LICENSE · PARTNERSHIP_DEED · TRUST_DEED · LOGO · PROOF_OF_FUNDS · ENHANCED_DUE_DILIGENCE · USA_W_8 · USA_W_9 · AFFIDAVIT
Attachment types — at the customer level
SOURCE_OF_FUNDS
SOURCE_OF_FUNDS(customer) — each customer's source of funds is recorded as a customer attachment, not as a field on the customer record. Mandatory for every UBO. Captured in Phase 2, Step 05. See the accepted values below.
Attachment types — at the organisation level
SOURCE_OF_FUNDS · SUBMIT_FOR_REVIEW · terms.acceptance
businessWebsite— the merchant's website URL is a field on the organisation, set at creation (Phase 1, Step 01) or update (Phase 4, Step 10). It is no longer an attachment.📘
SOURCE_OF_FUNDS(organisation) — mandatory for every merchant; recorded as an organisation attachment in Phase 3, Step 09.📘
SUBMIT_FOR_REVIEW— used in Phase 6, Step 17 to request an EFT Corporation compliance review. Send withfileName: Merchant Reviewandinfo: true.📘
terms.acceptance— the merchant's digital Terms & Conditions acceptance, captured in Phase 6, Step 16 via the dedicated T&C API. Retrieve the signed PDF viaGET .../attachments?attachmentType=terms.acceptance(base64EncodedAttachment).📘
mediaTypeis required in practice on all attachments (customer and organisation). The attachments API marksmediaTypeas optional, but the backend rejects a nullmedia_typewith400 SQL001— even for info-only attachments with no file. Always supply it:text/plainfor a text/JSONinfovalue, orapplication/pdf/image/png/image/jpegfor a document.
Position types
DIRECTOR · HEAD · OWNER · MANAGER · PARTNER · MEMBER · EMPLOYEE · PRIMARY_CONTACT
Ultimate Beneficial Owners (UBOs) — every individual with 5% or more ownership or control must be registered as a customer (Phase 2, Step 04) with their ID mandatorily uploaded and KYC'd. On the customer record, setotherto the UBO designation and ownership percentage (e.g.UBO – 25%), and record their source of funds as aSOURCE_OF_FUNDScustomer attachment. A UBO declaration is mandatory for every merchant.
Business types
LIMITED_COMPANY · SOLE_PROPRIETOR · PARTNERSHIP · CLOSE_CORPORATION · TRUST · PUBLIC_LISTED_COMPANY
Sole Proprietors — do not require organisation KYB. Run customer KYC on the owner, then create the wallet with the Sole Proprietor wallet type. Wallet types differ by business type (Phase 4, Step 13).
Source of funds — accepted values (SOURCE_OF_FUNDS attachment)
SOURCE_OF_FUNDS attachment)Used for both the customer-level and organisation-level SOURCE_OF_FUNDS attachments:
Salary · Securities / Investments · Property (Commercial / residential investments) · Beneficiaries of trusts or foundations · Inheritance, gift, or donations · Business / Partnership · Divorce settlement · Sale of business or other principle asset · Savings · Sale of Investments · Loan · Maturity or surrender of life assurance policy · Insurance claims · Other court award · Other income · Relationship to third party · Business income / profits · Asset swap · Winnings · Trust donor · Passive income (rental, dividends, interest) · Other
Identity types — AVS
| Code | Meaning |
|---|---|
SID | SA ID |
SPP | Passport |
SBR | Business Registration |
TRN | Tax Reference |
Wallet status codes
| Value | State |
|---|---|
0 | ACTIVE |
2 | BARRED |
1000 | CANCELLED |
One wallet per merchant — exactly one wallet is created per merchant organisation (Phase 4, Step 13).
Endpoint index
| Step | Method & path | API reference |
|---|---|---|
| 01 | POST .../organisations (sets businessWebsite) | Register a new organisation |
| 02 | POST .../organisations/{organisationId}/addresses | Add an address |
| 03 | HEAD .../customers | Check if a customer exists |
| 04 | POST .../customers · PUT .../customers/{customerId} | Register a new customer · Update a customer |
| 05 | POST .../customers/{customerId}/documents | Add a customer document |
| 05 | POST .../customers/{customerId}/attachments (SOURCE_OF_FUNDS) | Add a customer attachment |
| 06 | POST .../customers/{customerId}/identities (optional) | Create a customer identity |
| 07 | POST .../customers/{customerId}/positions | Add a customer position |
| 08 | POST .../organisations/{organisationId}/documents | Add an organisation document |
| 09 | POST .../organisations/{organisationId}/attachments (SOURCE_OF_FUNDS) | Add an organisation attachment |
| 10 | PUT .../organisations/{organisationId} (updates categoryCode, businessWebsite) | Update an organisation |
| 11 | POST .../organisations/{organisationId}/beneficiaries?onlyCheck=true | Add an organisation beneficiary |
| 12 | POST / GET .../organisations/{organisationId}/ratify (company) · POST .../customers/{customerId}/ratify (Sole Proprietor KYC) | Run KYB ratification · Run KYC on a customer |
| 13 | POST .../organisations/{organisationId}/wallets | Create an organisation wallet |
| 16 | POST .../integrations/JA-terms-and-conditions-initiate | Digital T&C acceptance — returns acceptanceUrl |
| 16 | GET .../organisations/{organisationId}/attachments?attachmentType=terms.acceptance | Retrieve signed T&Cs (base64EncodedAttachment) |
| 17 | POST .../organisations/{organisationId}/attachments (SUBMIT_FOR_REVIEW) | Add an organisation attachment |
| 19 | PUT .../wallets/{walletId} | Update a wallet (unbar) |
| 20 | GET .../wallets/{walletId} | Get wallet by walletId |
Operational reminders
- Treat the entire payload across all 20 steps as confidential and PII-bearing. Transport must be TLS 1.3; at rest your storage layer must encrypt with AES-256 or equivalent.
- Never log
base64EncodedDocumentcontent, identity numbers, orpasswordfields. Sanitise before persisting to your audit trail — PCI Requirement 10 plus ISO 27001 control A.8.10 (information deletion) apply. - Apply the Principle of Least Privilege to the API user you call Eclipse with: scope it to the onboarding endpoints used in this flow and rotate credentials on a defined cadence.
- The reseller remains the merchant's first line of support. Compliance-driven outcomes (EDD requests, rejection) must be communicated through the reseller — EFT Corporation does not contact the merchant directly.
Navigation
- ▲ Overview: Merchant Acquiring Reseller
- Support and escalations → Support
Updated about 1 hour ago
