Clients

Crea el client abans de construir un cobrament, un pagament o un compte bancari emès. Les capacitats, els comptes i les transferències s’associen a aquest client. Utilitza externalId com a mapatge estable al registre corresponent al teu sistema.

Environment variables

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

Clients individuals

Un individu només requereix type. Inclou els camps de perfil que ja coneixes i afegeix-ne més només quan la capacitat o la tasca actual els necessiti. Crea el client amb 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

Emmagatzema el data.id retornat com a CUSTOMER_ID. Consulta Incorporació d’individus per al context de política.

Clients de negoci

Un negoci requereix business.legalName. Crea el negoci amb la mateixa operació:

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

Emmagatzema el data.id retornat com a CUSTOMER_ID. Consulta Incorporació de negocis per al context de política i documents. Afegeix directors, propietaris i altres participants del negoci quan siguin coneguts o sol·licitats. Aquest exemple crea un director amb 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

Emmagatzema el data.id retornat com a RELATED_PARTY_ID. Si necessites exportar un client, utilitza POST /v3/customers/{customerId}/export i segueix l’esquema de la sol·licitud. El format json_basic_data retorna el recurs de client públic v3 actual com a fitxer adjunt JSON; cada crida recalcula les dades actuals i exclou els documents i les metadades de documents. Per a un format de token de portabilitat, envia l’ID de client del projecte KYC receptor com a forClientId, no el customerId de Swipelux. Utilitza el data.token retornat abans de data.expiresAt. Reutilitzar la mateixa Idempotency-Key i el mateix cos repeteix aquell resultat de token; utilitza una clau nova per emetre un altre token.

Llegeix la preparació a partir de les capacitats

Un client no té un estat de verificació o de preparació a l’API. Llegeix el client amb GET /v3/customers/{customerId} per obtenir les dades de perfil actuals, i després utilitza les capacitats i els seus openTaskIds per decidir què pot fer a continuació el client.

Get customer

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

Troba clients amb documents pendents

Per saber quins clients d’una pàgina encara han d’aportar documents obligatoris, passa include=documentRequirements a GET /v3/customers. Pots combinar-ho amb els resums de capacitats com a include=capabilities,documentRequirements. Les claus d’API necessiten accounts:read per a l’expansió documentRequirements. Aleshores, cada resum de client inclou un objecte documentRequirements:

Document requirement summary

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

count és el nombre de requisits de documents obligatoris en action_required en tasques que també estan en action_required. Cobreix tots els àmbits de tasca, incloses les tasques de tot el compte, i no depèn de la preparació de les capacitats.
required és true quan count és més gran que 0.
Un conjunt d’alternatives compta una sola vegada, i només quan totes les alternatives requereixen un document.

El resum és conservador. Exclou els documents opcionals, els documents obligatoris condicionalment i les alternatives que barregen vies amb document i sense document. També exclou els requisits que el client pot completar mitjançant la verificació allotjada. Per tant, required: false no demostra que no s’apliqui cap tasca de documents. Utilitza’l per prioritzar clients i, després, llegeix les seves tasques per obtenir la llista autoritzada del que cal recollir. Sense l’expansió, la resposta omet documentRequirements. A continuació, continua a Capacitats i tasques per descobrir i activar el resultat de producte que necessites.

Comença aquí

Incorpora clients

Construeix fluxos de diners

Llança

Clients individuals

Clients de negoci

Llegeix la preparació a partir de les capacitats

Troba clients amb documents pendents

​Clients individuals

​Clients de negoci

​Afegeix parts relacionades del negoci

​Llegeix la preparació a partir de les capacitats

​Troba clients amb documents pendents

Clients individuals

Clients de negoci

Afegeix parts relacionades del negoci

Llegeix la preparació a partir de les capacitats

Troba clients amb documents pendents