Customers

POST /customers

Obligatoire — informations personnelles

• first_name, last_name
• email
• phone — Format E.164 (ex. +50949324932)
• country_code — Pays émetteur ISO 3166-1 alpha-2 (ex. HT pour Haïti). Envoyez HT ou HTG — HeyQo conserve votre valeur ; le pays émetteur est mappé vers DOM (République dominicaine), comme le formulaire HeyQo.
• date_of_birth — Y-m-d (format de date (ex. 1990-05-15)

Optionnel — pièce d'identité (KYC)

• gender — male, female, other
• document_type — NATIONAL_ID, PASSPORT, DRIVERS_LICENSE, …
• document_number — numéro de pièce d'identité
• tax_id_number — confirmation fiscale / ID national (comme le formulaire HeyQo)
• document_front_base64 — JPG ou PNG, encodé en base64 (requis pour soumettre les documents KYC)
• document_back_base64 — verso optionnel (non utilisé pour le passeport)

Optionnel — adresse de résidence

• address_street, address_city, address_state, address_postal_code
• address_country — pays de résidence (code ISO ou nom ; par défaut country_code)
• address_document_base64 ou proof_of_address_base64 — facture, relevé bancaire ou selfie avec pièce (JPG/PNG base64)

Optionnel — preuve de fonds

Envoyez un objet imbriqué proof_of_funds ou des champs plats pof_* (mêmes valeurs que l'app HeyQo) :

• pof_employment_status — employed, self_employed, student, retired, homemaker, unemployed
• pof_occupation — code profession officiel (ex. 151252)
• pof_primary_purpose — ex. personal_or_living_expenses, payments_to_friends_or_family_abroad
• pof_source_of_funds — ex. salary, savings, company_funds
• pof_expected_monthly_pay — 0_4999 or 5000_9999

external_ref — votre ID utilisateur interne (optionnel, unique par partenaire).

Création minimale (profil uniquement)

curl -X POST "https://heyqo.cash/business/v1/customers" \
  -H "Authorization: Bearer TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Bellamy",
    "last_name": "TestClient",
    "email": "bellamy.test@heyqo.cash",
    "phone": "+50949324932",
    "country_code": "HT",
    "date_of_birth": "1990-05-15",
    "external_ref": "partner-user-123"
  }'

Création KYC complète (mêmes champs que le formulaire HeyQo)

curl -X POST "https://heyqo.cash/business/v1/customers" \
  -H "Authorization: Bearer TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Bellamy",
    "last_name": "TestClient",
    "email": "bellamy.test@heyqo.cash",
    "phone": "+50949324932",
    "country_code": "HT",
    "date_of_birth": "1990-05-15",
    "gender": "male",
    "document_type": "NATIONAL_ID",
    "document_number": "GOV-123456",
    "tax_id_number": "GOV-123456",
    "document_front_base64": "BASE64_JPG_OR_PNG...",
    "document_back_base64": "BASE64_JPG_OR_PNG...",
    "address_street": "12 Rue Capois",
    "address_city": "Port-au-Prince",
    "address_state": "Ouest",
    "address_postal_code": "6110",
    "address_country": "HT",
    "proof_of_address_base64": "BASE64_JPG_OR_PNG...",
    "pof_employment_status": "employed",
    "pof_occupation": "151252",
    "pof_primary_purpose": "personal_or_living_expenses",
    "pof_source_of_funds": "salary",
    "pof_expected_monthly_pay": "0_4999"
  }'

Seuls JPG et PNG sont acceptés pour les documents. Encodez en base64 brut (sans préfixe data-URI).

GET /customers

Liste des clients enregistrés sur votre compte partenaire.

GET /customers/{id}

Utilisez l'id client (retourné par POST /customers) ou le local_id HeyQo.

PATCH /customers/{id}

Mettre à jour le profil ou resoumettre le KYC. Accepte les mêmes champs optionnels que POST (documents, adresse, preuve de fonds).