Képességek és feladatok

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

​

Támogatott képességek felfedezése

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

{
  "institutions": [
    {
      "id": "jpmorgan",
      "name": "JPMorgan Chase",
      "bic": "CHASUS33",
      "logoUrl": "https://wallet.swipelux.com/bank-logos/jpmorgan.png",
      "countries": ["US"],
      "isDefault": true
    }
  ]
}

​

Közös és dedikált számlatípusok

• pooled: közös Swipelux bankszámla. Minden pénzbefizetés egyedi hivatkozást használ a pénz irányítására. Egyszeri átutalásokhoz válassza ezt.
• named: dedikált banki adatok az ügyfélnek (virtuális IBAN, dedikált ACH számla). Újrafelhasználható és megosztható bármely fizetővel. Kibocsátott bankszámlákhoz szükséges.

​

A képesség kérése

curl --request POST \
  "${API_BASE}/v3/customers/${CUSTOMER_ID}/capabilities/${CAPABILITY_ID}" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}" \
  --header "Idempotency-Key: capability-request-001" \
  --header "Content-Type: application/json" \
  --data '{}'

​

Megosztott alkalmazások bankonként

• Egyetlen jóváhagyás több képességet is lefedhet. Például egy banknál jóváhagyott eset egy ACH és egy wire képességet is ready állapotba hozhat.
• Egy későbbi kérés, amely egy meglévő esetnek megfelel, azt újrahasznosítja. A Swipelux nem nyit második alkalmazást, és nem ad hozzá duplikált feladatokat.
• A különböző bankoknál lévő esetek függetlenek. Az egyik banknál történt elutasítás nem érinti a másik banknál lévő esetet.

• A 201 azt jelenti, hogy a kérés új alkalmazási esetet nyitott.
• A 200 azt jelenti, hogy a kérés egy, az ügyfélnél már meglévő alkalmazási esetre oldódott fel, például egy olyan banki képesség ismételt kérésekor, amellyel az ügyfél már rendelkezik, vagy egy törölt képesség kérésekor. A card vagy stablecoin_transfers ismételt kérése továbbra is 409 capability_already_exists hibát ad vissza.
• A selectedApplicationId egy legfelső szintű mező a data mellett, amely a kérés által kiválasztott vagy megnyitott eset azonosítóját tartalmazza. A Swipelux kihagyja, ha a kérés nem választott ki esetet. Egy idempotens ismétlés ugyanazt az értéket adja vissza.

{
  "data": {
    "id": "ach_named",
    "status": "pending",
    "openTaskIds": ["tsk_000000000000000002"],
    "applications": [{ "id": "apl_000000000000000005", "status": "in_review" }]
  },
  "selectedApplicationId": "apl_000000000000000005"
}

​

Az ügyfél alkalmazásainak listázása

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

• scope: named egy banknál lévő esethez, provider_pooled vagy platform bank nélküli esetekhez, vagy null egy besorolatlan korábbi esethez. Az institution hiányzik a provider_pooled és platform eseteknél.
• requestedScope[]: az esethez kért képességkulcsok, mindegyik az első requestedAt értékével. A bejegyzések soha nem törlődnek.
• coverage[]: az eset jóváhagyása által lefedett képességkulcsok, mindegyik grantedAt és source értékkel. A lefedettség a hatókört rögzíti, nem az engedélyezést. Az aktuális státuszért olvassa be a képességet.
• probes[]: módszerellenőrzések az eset által lefedett közös képességkulcsokhoz, mindegyik capabilityKey, status és reason értékkel. A dedikált kulcsokhoz soha nem szükséges ellenőrzés.
• generation, predecessorApplicationId és supersededByApplicationId: utódlási hivatkozások. Ha a supersededByApplicationId be van állítva, az esetet lecserélték. Kövesse ezt az azonosítót az aktuális esethez. Egy képesség applications[] listája csak az aktuális eseteket tartalmazza, így a lecserélt eset csak ebben a listában jelenik meg.

{
  "data": [
    {
      "id": "apl_000000000000000005",
      "status": "ready",
      "scope": "named",
      "institution": { "id": "jpmorgan", "name": "JPMorgan Chase", "bic": "CHASUS33" },
      "requestedScope": [
        { "capabilityKey": "ach_named", "requestedAt": "2026-09-20T10:00:00.000Z" }
      ],
      "coverage": [
        { "capabilityKey": "ach_named", "grantedAt": "2026-09-22T12:00:00.000Z", "source": "approval" },
        { "capabilityKey": "wire_named", "grantedAt": "2026-09-22T12:00:00.000Z", "source": "approval" }
      ],
      "probes": [],
      "generation": 1,
      "predecessorApplicationId": null,
      "supersededByApplicationId": null
    }
  ],
  "nextCursor": null,
  "hasMore": false
}

​

Aktuális feladatok elvégzése

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

​

Újrahasznosított profilbizonyítékok

​

Követelmények megjelenítése

• allowedValues: a megengedett értékek egy skaláris mezőhöz, vagy egy tömbmező minden eleméhez. Ezeket az értékeket küldje be, ne a lefordított megjelenítési címkéket.
• valueSchema: önálló JSON Schema Draft 7 dokumentum, amely leírja a bevitel alakját, a beágyazott tulajdonságokat, a kötelező mezőket és a szerkezeti megkötéseket. Az objektumokon lévő enumok a megfelelő tulajdonságon jelennek meg, például adóazonosítóknál a valueSchema.items.properties.type.enum helyen. A Swipelux a beküldés után továbbra is alkalmaz mezők közötti és felülvizsgálati validációt, így a sémának megfelelő érték is elutasításra kerülhet.
• valueType: "country", vagy tömbök esetén itemValueType: "country": a mező nagybetűs ISO 3166-1 alpha-2 kódokat fogad. A valueSchema beágyazott országtulajdonságai a format: "iso-3166-1-alpha-2" értéket használják. A lokalizált címkékhez használjon szabványos országlistát.

{
  "id": "req_000000000000000010",
  "key": "account_purposes",
  "title": "Account purpose",
  "status": "action_required",
  "request": {
    "type": "profile",
    "prompt": "Select every purpose that applies.",
    "required": true,
    "profilePointer": "/financialProfile/accountPurposes",
    "valueType": "array",
    "itemValueType": "string",
    "allowedValues": ["business_expenses", "ecommerce", "payroll"],
    "valueSchema": {
      "$schema": "http://json-schema.org/draft-07/schema#",
      "type": "array",
      "items": { "enum": ["business_expenses", "ecommerce", "payroll"] }
    }
  }
}

​

Hosted műveletek

• Az action.kind: "available" tartalmazza az action.url és action.expiresAt mezőket (jelenleg mindig null). Tárolja az action.url értékét, küldje oda az ügyfelet, majd olvassa be újra a feladatot. A munkamenetszintű url és expiresAt mezők ugyanezeket az értékeket tartalmazzák.
• Az action.kind: "unavailable" azt jelenti, hogy nem szabad hivatkozást megjeleníteni. A munkamenetszintű url és expiresAt mezők hiányoznak. A munkamenet status értéke önmagában nem határozza meg, melyik művelettípust kapja.

{
  "data": {
    "verificationSessions": [
      {
        "id": "vfy_000000000000000003",
        "key": "identity_verification",
        "type": "identity_verification",
        "status": "action_required",
        "action": {
          "kind": "available",
          "url": "https://platform.swipelux.com/kyc/redirect/cus_000000000000000001/tsk_000000000000000002/vfy_000000000000000003",
          "expiresAt": null
        },
        "url": "https://platform.swipelux.com/kyc/redirect/cus_000000000000000001/tsk_000000000000000002/vfy_000000000000000003",
        "expiresAt": null
      }
    ],
    "tosSessions": [
      {
        "id": "vfy_000000000000000004",
        "key": "terms_of_service",
        "type": "terms_of_service",
        "status": "completed",
        "action": { "kind": "unavailable" }
      }
    ]
  }
}

​

Dokumentumok feltöltése

export DOCUMENT_PATH='/absolute/path/to/requested-document.pdf'

curl --request POST \
  "${API_BASE}/v3/customers/${CUSTOMER_ID}/documents" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}" \
  --header "Idempotency-Key: customer-document-001" \
  --form "file=@${DOCUMENT_PATH}"

​

API válaszok

curl --request POST \
  "${API_BASE}/v3/customers/${CUSTOMER_ID}/tasks/${TASK_ID}/submissions" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}" \
  --header "Idempotency-Key: task-submission-001" \
  --header "Content-Type: application/json" \
  --data @- <<'JSON'
{
  "taskRevision": 3,
  "answers": [
    {
      "requirementId": "req_from_current_task",
      "answer": {
        "type": "text",
        "value": "Current answer"
      }
    }
  ]
}
JSON

​

Haszonhúzó előfeltétel vállalkozásoknál

{
  "type": "resource_reference",
  "prompt": "Add or select a qualifying beneficial owner.",
  "required": true,
  "resourceType": "related_party",
  "qualification": "beneficial_owner"
}

• Egy megfelelő kapcsolt fél létrehozása vagy frissítése ugyanabban az újraértékelésben teljesíti a követelményt, és megnyitja az adott tulajdonos saját profil- és dokumentummunkáját. Lásd az Üzleti kapcsolt felek hozzáadása oldalt.
• Hivatkozhat egy megfelelő félre explicit módon is egy resource_reference válasszal, amely tartalmazza annak relatedPartyId értékét.
• A követelmény a teljesítése után is listázva marad az aktuális feladatban. Amikor más nyitott kötelezettség nem marad, a feladat satisfied státuszba kerül.
• Az utolsó megfelelő fél archiválása, vagy az őt minősítő tények eltávolítása újranyitja a követelményt, még azután is, hogy a feladat satisfied lett.

​

Folytatás, amikor a képesség kész

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