Ügyfelek

Hozza létre az ügyfelet, mielőtt pénzbefizetést, kifizetést vagy kibocsátott bankszámlát épít. A képességek, számlák és átutalások az adott ügyfélhez tartoznak. Az externalId használatával stabil hozzárendelést tehet a rendszerében lévő rekordhoz.

Environment variables

export API_BASE='https://platform.swipelux.com'
export SWIPELUX_API_KEY='replace-with-your-api-key'

Magánszemély ügyfelek

Egy magánszemélyhez csak a type szükséges. Adja hozzá a már ismert profilmezőket, és csak akkor tegyen hozzá többet, ha az aktuális képességnek vagy feladatnak szüksége van rájuk. Hozza létre az ügyfelet a POST /v3/customers művelettel:

Create individual customer

curl --request POST \
  "${API_BASE}/v3/customers" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}" \
  --header "Idempotency-Key: customer-user-123" \
  --header "Content-Type: application/json" \
  --data @- <<'JSON'
{
  "type": "individual",
  "externalId": "user_123",
  "individual": {
    "firstName": "Amina",
    "lastName": "Diallo",
    "residenceCountry": "FR"
  }
}
JSON

Tárolja a visszakapott data.id értéket CUSTOMER_ID-ként. A szabályzati kontextushoz lásd a Magánszemély onboarding oldalt.

Üzleti ügyfelek

Az üzleti ügyfélhez a business.legalName szükséges. Hozza létre a vállalkozást ugyanazzal a művelettel:

Create business customer

curl --request POST \
  "${API_BASE}/v3/customers" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}" \
  --header "Idempotency-Key: customer-company-456" \
  --header "Content-Type: application/json" \
  --data @- <<'JSON'
{
  "type": "business",
  "externalId": "company_456",
  "business": {
    "legalName": "Acme Payments SAS"
  }
}
JSON

Tárolja a visszakapott data.id értéket CUSTOMER_ID-ként. A szabályzati és dokumentum-kontextushoz lásd az Üzleti onboarding oldalt. Adja hozzá az igazgatókat, tulajdonosokat és egyéb üzleti résztvevőket, ha ismertek vagy kértek. Ez a példa egy igazgatót hoz létre a POST /v3/customers/{customerId}/related-parties művelettel:

Add related party

curl --request POST \
  "${API_BASE}/v3/customers/${CUSTOMER_ID}/related-parties" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}" \
  --header "Idempotency-Key: related-party-director-001" \
  --header "Content-Type: application/json" \
  --data @- <<'JSON'
{
  "partyType": "person",
  "roles": ["director"],
  "title": "Chief executive officer",
  "person": {
    "firstName": "Amina",
    "lastName": "Diallo",
    "residenceCountry": "FR"
  }
}
JSON

Tárolja a visszakapott data.id értéket RELATED_PARTY_ID-ként. Ha ügyfelet kell exportálnia, használja a POST /v3/customers/{customerId}/export műveletet, és kövesse a kérési sémáját. A json_basic_data formátum az aktuális nyilvános v3 ügyfél-erőforrást adja vissza JSON-mellékletként; minden hívás újraszámítja az aktuális adatokat, és kizárja a dokumentumokat és a dokumentum-metaadatokat. Hordozhatósági token formátumhoz a fogadó KYC-projekt kliensazonosítóját küldje el forClientId értékként, ne a Swipelux customerId értékét. A visszakapott data.token értéket a data.expiresAt időpont előtt használja fel. Ugyanazon Idempotency-Key és törzs újbóli használata ugyanazt a tokeneredményt játssza vissza; új token kibocsátásához használjon új kulcsot.

Készenlét olvasása képességekből

Az ügyfélnek nincs ellenőrzési vagy készenléti státusza az API-ban. Olvassa be az ügyfelet a GET /v3/customers/{customerId} művelettel az aktuális profiladatokért, majd használja a képességeket és azok openTaskIds értékeit annak eldöntéséhez, hogy az ügyfél mit tehet legközelebb.

Get customer

curl --request GET \
  "${API_BASE}/v3/customers/${CUSTOMER_ID}" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}"

Hiányzó dokumentumokkal rendelkező ügyfelek keresése

Ha meg szeretné tudni, mely ügyfeleknek kell még kötelező dokumentumokat benyújtaniuk egy oldalon, adja át az include=documentRequirements paramétert a GET /v3/customers végpontnak. Kombinálhatja a képesség-összefoglalókkal include=capabilities,documentRequirements formában. Az API-kulcsoknak accounts:read jogosultságra van szükségük a documentRequirements bővítéshez. Ekkor minden ügyfél-összefoglaló tartalmaz egy documentRequirements objektumot:

Document requirement summary

{
  "documentRequirements": {
    "required": true,
    "count": 2
  }
}

A count azoknak a kötelező dokumentumkövetelményeknek a száma, amelyek action_required állapotban vannak olyan feladatokon, amelyek szintén action_required állapotúak. Minden feladathatókört lefed, beleértve a teljes számlára vonatkozó feladatokat is, és nem függ a képességek készenlététől.
A required értéke true, ha a count nagyobb, mint 0.
Egy alternatívakészlet egyszer számít, és csak akkor, ha minden alternatíva dokumentumot igényel.

Az összefoglaló óvatos. Kizárja az opcionális dokumentumokat, a feltételesen kötelező dokumentumokat, valamint azokat az alternatívákat, amelyek dokumentumos és nem dokumentumos utakat kevernek. Kizárja azokat a követelményeket is, amelyeket az ügyfél hosztolt ellenőrzéssel teljesíthet. Ezért a required: false nem bizonyítja, hogy nem vonatkozik rá dokumentumfeladat. Használja az ügyfelek rangsorolására, majd olvassa be a feladataikat a begyűjtendők hiteles listájáért. A bővítés nélkül a válasz nem tartalmazza a documentRequirements mezőt. Ezután folytassa a Képességek és feladatok oldalon a szükséges termékeredmény felfedezéséhez és aktiválásához.

Kezdő lépések

Ügyfelek beléptetése

Pénzáramlások kiépítése

Élesítés

Magánszemély ügyfelek

Üzleti ügyfelek

Készenlét olvasása képességekből

Hiányzó dokumentumokkal rendelkező ügyfelek keresése

​Magánszemély ügyfelek

​Üzleti ügyfelek

​Üzleti kapcsolt felek hozzáadása

​Készenlét olvasása képességekből

​Hiányzó dokumentumokkal rendelkező ügyfelek keresése

Magánszemély ügyfelek

Üzleti ügyfelek

Üzleti kapcsolt felek hozzáadása

Készenlét olvasása képességekből

Hiányzó dokumentumokkal rendelkező ügyfelek keresése