Skip to main content

Personal account flow

TestEndpointTask
Create a personal applicationPOST /v2/applicationsSubmit a personal application with type: 'INDIVIDUAL', including address, feature information (payments and/or cards), and personal details. Verify the response returns a DRAFT status and an applicationId.
Update an applicationPATCH /v2/applications/:applicationIdModify a draft application and confirm the response reflects your changes.
Upload a documentPOST /v2/applications/:applicationId/documentsUpload a supporting document (e.g. proof of identity). Verify the upload succeeds and the document is linked to the application.
Submit a personal applicationPOST /v2/applications/:applicationId/submitSubmit the application and verify the status changes to SUBMITTED.

Business account flow

TestEndpointTask
Create associated peoplePOST /v2/applications/associated-peopleCreate at least one APPLICANT and one ULTIMATE_BENEFICIAL_OWNER. Verify the response returns IDs for each person.
Create a business applicationPOST /v2/applicationsSubmit a business application (e.g. PRIVATE_COMPANY) with registered address, feature information, industry codes, and linked associated people. Verify a DRAFT status and applicationId are returned.
Upload associated person documentsPOST /v2/applications/associated-people/:associatedPersonId/documentsUpload a document for an associated person and verify it’s linked correctly.
Submit a business applicationPOST /v2/applications/:applicationId/submitSubmit the application and verify the status changes to SUBMITTED.

Webhooks

TestEndpointTask
Receive IdentityVerificationRequested webhookn/aIf using the Managed by Equals KYC model, verify you receive this webhook with an actionUrl for identity verification.
Receive KycInformationRequest or KybInformationRequest webhookn/aIf additional documentation is needed, verify this webhook is received and parsed correctly.
Receive ApplicationStatusUpdated webhookn/aVerify you receive the approval or decline notification and handle both outcomes.
Receive AccountActivated webhookn/aVerify the webhook is received with settlement details (sort code, account number, IBAN, etc.) and that your app stores them correctly.

Optional

TestEndpointTask
Save an address to your accountPOST /v2/addressesAdd an address to your account and check that a new ID is created for it. This is optional but recommended if you plan to convert virtual cards into physical ones.