Claim codes

Claim addressing is for a recipient whose name you know but whose NIN, email, or CAC number you do not hold. Supply the declared name when running a plan:

{
  "recipients": [
    {
      "addressing": { "type": "claim", "declared_name": "Ngozi Nwachukwu" },
      "display_name": "Ngozi Nwachukwu",
      "ref": "CUST-100439"
    }
  ]
}

Keepable deposits the correspondence and creates a single-use code. Keepable does not contact the person; your organisation delivers that code over a channel it already controls.

Retrieve codes

GET https://api.keepable.co/sender/v2/correspondence/cor_01J8ZQ4T/claims?state=awaiting&limit=50
Authorization: Bearer {{KEEPABLE_TOKEN}}

Each claim includes your ref, its state, expiry, and the live code while it is awaiting. A claim is awaiting, claimed, expired, or voided. Claimed and voided codes are spent and no longer return their value.

The claimant enters the code inside Keepable after verifying their NIN. Keepable also checks the NIMC-verified name against the name you declared, so a code alone is insufficient.

Reconcile redemption

Handle claim.claimed and claim.expired webhooks. The claimed event carries the spent claim and your ref, allowing you to update your own record without polling.

Voiding and reissuing codes are operator recovery actions in Workspace, not API-key operations.