Klienti

Izveidojiet klientu, pirms veidojat iemaksu, izmaksu vai izsniegtu bankas kontu. Iespējas, konti un pārvedumi ir ierobežoti ar šo klientu. Izmantojiet externalId kā stabilu piesaisti attiecīgajam ierakstam jūsu sistēmā.

Environment variables

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

Privātpersonas klienti

Privātpersonai nepieciešams tikai type. Iekļaujiet profila laukus, kurus jau zināt, un pievienojiet citus tikai tad, kad pašreizējai iespējai vai uzdevumam tie ir nepieciešami. Izveidojiet klientu ar POST /v3/customers:

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

Saglabājiet atgriezto data.id kā CUSTOMER_ID. Skatiet Privātpersonu iesaiste, lai iepazītos ar politikas kontekstu.

Uzņēmumu klienti

Uzņēmumam nepieciešams business.legalName. Izveidojiet uzņēmumu ar to pašu operāciju:

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

Saglabājiet atgriezto data.id kā CUSTOMER_ID. Skatiet Uzņēmumu iesaiste, lai iepazītos ar politiku un dokumentu kontekstu. Pievienojiet direktorus, īpašniekus un citus uzņēmuma dalībniekus, kad tie ir zināmi vai pieprasīti. Šis piemērs izveido direktoru ar POST /v3/customers/{customerId}/related-parties:

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

Saglabājiet atgriezto data.id kā RELATED_PARTY_ID. Ja nepieciešams eksportēt klientu, izmantojiet POST /v3/customers/{customerId}/export un ievērojiet tā pieprasījuma shēmu. Formāts json_basic_data atgriež pašreizējo publisko v3 klienta resursu kā JSON pielikumu; katrs izsaukums pārrēķina pašreizējos datus un neietver dokumentus un dokumentu metadatus. Pārnesamības marķiera formātam nosūtiet saņemošā KYC projekta klienta ID kā forClientId, nevis Swipelux customerId. Izmantojiet atgriezto data.token pirms data.expiresAt. Tā paša Idempotency-Key un pamatteksta atkārtota izmantošana atkārto šo marķiera rezultātu; izmantojiet jaunu atslēgu, lai izsniegtu citu marķieri.

Nolasiet gatavību no iespējām

Klientam API nav verifikācijas vai gatavības statusa. Nolasiet klientu ar GET /v3/customers/{customerId}, lai iegūtu pašreizējos profila datus, pēc tam izmantojiet iespējas un to openTaskIds, lai izlemtu, ko klients var darīt tālāk.

Get customer

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

Atrodiet klientus ar neiesniegtiem dokumentiem

Lai noskaidrotu, kuriem klientiem lapā vēl jāiesniedz obligātie dokumenti, nododiet include=documentRequirements uz GET /v3/customers. To var apvienot ar iespēju kopsavilkumiem kā include=capabilities,documentRequirements. API atslēgām documentRequirements paplašinājumam ir nepieciešama accounts:read atļauja. Pēc tam katrs klienta kopsavilkums ietver documentRequirements objektu:

Document requirement summary

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

count ir obligāto dokumentu prasību skaits statusā action_required uzdevumos, kas arī ir statusā action_required. Tas aptver visus uzdevumu tvērumus, tostarp visa konta uzdevumus, un nav atkarīgs no iespēju gatavības.
required ir true, ja count ir lielāks par 0.
Alternatīvu kopa tiek skaitīta vienreiz, un tikai tad, ja katrai alternatīvai ir nepieciešams dokuments.

Kopsavilkums ir piesardzīgs. Tas izslēdz neobligātos dokumentus, nosacīti obligātos dokumentus un alternatīvas, kas apvieno dokumentu un nedokumentu ceļus. Tas izslēdz arī prasības, kuras klients var izpildīt, izmantojot mitināto verifikāciju. Tāpēc required: false nepierāda, ka neviens dokumentu uzdevums nav piemērojams. Izmantojiet to klientu prioritizēšanai, pēc tam nolasiet viņu uzdevumus, lai iegūtu autoritatīvu sarakstu ar to, kas jāsavāc. Bez paplašinājuma atbildē nav documentRequirements. Tālāk turpiniet uz Iespējas un uzdevumi, lai atklātu un aktivizētu nepieciešamo produkta rezultātu.

Sākt darbu

Klientu iekļaušana

Veidot naudas plūsmas

Palaišana

Privātpersonas klienti

Uzņēmumu klienti

Nolasiet gatavību no iespējām

Atrodiet klientus ar neiesniegtiem dokumentiem

​Privātpersonas klienti

​Uzņēmumu klienti

​Pievienojiet uzņēmuma saistītās puses

​Nolasiet gatavību no iespējām

​Atrodiet klientus ar neiesniegtiem dokumentiem

Privātpersonas klienti

Uzņēmumu klienti

Pievienojiet uzņēmuma saistītās puses

Nolasiet gatavību no iespējām

Atrodiet klientus ar neiesniegtiem dokumentiem