Overview

The Reap Compliance API verifies cardholders and businesses for card issuance through the Reap CaaS API. Four integration methods are supported across two entity types, differentiated by verification source and submission shape.

Approval of an entity returns a signed payload that authorises card creation through POST /cards. Approval status is delivered asynchronously by webhook for methods that support webhook notifications.

Method Selection

Comparison

Decision Guide

Conditions apply in order.

1. Entity type. Business customers route to Universal KYB. Individual cardholders proceed to step 2.
2. Existing SumSub verifications. Applicants already verified in a separate SumSub account route to SumSub KYC Token Sharing. All other cardholders proceed to step 3.
3. Verification ownership. Verification hosted by Reap through the SumSub WebSDK routes to KYCaaS. Verification performed externally with results submitted to Reap routes to Universal KYC. The provisioned method specified in the CaaS contract takes precedence over this guide. Reap account managers can confirm the provisioned method when unclear.

Integration Methods

KYCaaS

Hosted identity verification for individual cardholders through the SumSub WebSDK. Reap orchestrates the verification and returns the decision via webhook.

Use a different method when applicants are already verified in a separate SumSub account (SumSub KYC Token Sharing) or when verification results from an alternative provider are submitted directly (Universal KYC).

KYCaaS Integration Guide

SumSub KYC Token Sharing

Migration of applicants already verified in a separate SumSub account into Reap with no repeat verification required. Two ingestion modes are available, batch CSV upload and single record synchronous ingestion.

Use a different method when applicants require initial verification through Reap (KYCaaS) or when verification was performed through a provider other than SumSub (Universal KYC).

SumSub KYC Sharing Guide

Universal KYC

Submission of verified individual cardholder data to Reap using a canonical payload structure. Reap retains final approval authority.

Behaviour after approval depends on the sponsorship model. Programs without BIN sponsorship fetch the signed payload and call POST /cards. Programs with BIN sponsorship use the verified data directly in downstream card issuance.

Use a different method when Reap should host the verification UI (KYCaaS) or when applicants were already verified in a separate SumSub account (SumSub KYC Token Sharing).

Universal KYC Guide

Universal KYB

Onboarding of business entities into the Reap platform using a canonical payload structure. Coverage includes legal identity, ultimate beneficial owners, due diligence questionnaire, optional enhanced due diligence, and supporting business documents.

Use a different method when the entity is an individual cardholder (KYCaaS, SumSub KYC Token Sharing, or Universal KYC).

Universal KYB Guide

Authentication

All Reap Compliance API requests require an API key passed in the x-reap-api-key header.

x-reap-api-key: <API_KEY>

API keys are generated in the Reap Dashboard at Settings → Product Settings → KYC API Keys and are linked to a Business UUID (BUUID) that scopes all activity to the issuing business. Sandbox validation is required before switching to production keys.

Core Concepts

Business

The organisation registered with Reap, identified by a unique API Key and Business UUID (BUUID). All entities, requirements, and KYC activity are scoped to the BUUID.

Entity

The individual or business being verified. Every applicant is represented as an entity created via POST /entity with type: INDIVIDUAL or type: BUSINESS.

Reap assigns a unique entityId at creation. An optional externalId may be supplied to correlate the entity with the integrator's internal records.

{
  "entityId": "ent_123e4567-e89b-12d3-a456-426614174000",
  "externalId": "user_123"
}

Entity type by method.

Feature

A capability enabled for a business. Card Issuance is the feature governing verification and card issuance authority and must be enabled by Reap before use.

Requirement Slug

A typed string identifier for a specific document category or canonical submission. Examples include ukyc-id-document and ukyc-proof-of-address-document for Universal KYC, and certificate-of-incorporation, ubo-kyc, and board-resolution for Universal KYB.

Status

Every entity and requirement carries a status from the RequirementStatus enum.

Signed Payload

A cryptographically signed object retrieved from Reap once an entity reaches APPROVED. The payload authorises card creation when passed into POST /cards.

Shape depends on the method.

External ID

An integrator supplied identifier passed as externalId and echoed back by Reap. Used to correlate Reap records with integrator internal records.

BIN Country and Jurisdiction Data

binCountry is the ISO 3166-1 alpha-3 code of the issuing BIN. The field is included only when the issuing BIN belongs to a jurisdiction with jurisdiction specific KYC requirements (currently MEX).

For Universal KYC, a matching jurisdictionData.<COUNTRY> block accompanies binCountry. The field is independent of identity.nationality, and nationality driven document requirements (such as ukyc-curp-document for Mexican nationals) are determined separately.

Webhook Notifications

Webhooks deliver asynchronous compliance status updates from Reap, available only for KYCaaS and Universal KYC. SumSub KYC Token Sharing and Universal KYB do not emit account_status_change events.

All supported deliveries use the account_status_change event type. The most common event is card_issuance_api_access_updated, signalling that an entity's Card Issuance KYC API access has been granted, revoked, or that an individual requirement has been rejected.

Documentation Map

Next Steps

1. Identify the appropriate integration method using the Comparison table and Decision Guide.
2. For KYCaaS or Universal KYC, configure the webhook endpoint first by following the Webhook Setup guide.
3. Follow the appropriate integration guide.
   • KYCaaS Integration Guide
   • SumSub KYC Sharing Guide
   • Universal KYC Guide
   • Universal KYB Guide