Skip to main content
POST
Adds a KYC source to your instance and returns its invite. The invite is one string that holds everything the verifier needs: the API address, the source ID, a token for the inbox, your record key and the profile key. See Sealed KYC records. Your instance needs a record key first. Register it with Set Record Key.
The invite is a secret, because it carries the source’s token. It is returned by this call and by Reissue Source Invite only, and cannot be read back later. Hand it to the verifier over a confidential channel.Trusset relays the invite, so do not rely on it alone for the keys. Before the first delivery, read your record key fingerprint to the verifier over a channel that does not run through Trusset, for example by phone. Take it from trusset-kyc key show on your own machine, never from the Trusset app or an API response, because those come from Trusset like the invite. The verifier’s tool stores the invite only when that fingerprint matches the key in it (trusset-kyc invite add --fingerprint). Have the verifier read you the fingerprint of its signing key the same way. Then pin that signing key in your tool with trusset-kyc source add, which prints the fingerprint it pinned. Your tool verifies every record against the key you pinned there. The key stored here is what Trusset checks deliveries against, and your tool shows it only as a hint.

Binding whitelists

accessListIds binds up to 10 whitelists to the source. Each must be a list your instance keeps, or one a verified wallet of your instance manages, on your instance’s network. Binding has two effects:
  • Approve KYC Record returns the transaction that lists the record’s wallet on each bound list.
  • Set Whitelist Members refuses to list a wallet on a bound list unless the wallet has an approved, valid record from a source bound to that list (409 KYC_RECORD_REQUIRED).
A source without a bound list still delivers records, and you can open, approve and reject them. Approving then returns no admissions.

Body Parameters

string
required
A name for the source, 1 to 80 characters: letters, digits, spaces and . , & ( ) ' _ -, starting with a letter or a digit. It must be unique among the sources of your instance that are not removed, in any letter case.
string
required
The verifier’s Ed25519 public key as 64 hex characters, with or without a 0x prefix. trusset-kyc source-keygen prints it on the verifier’s side. Each source of your instance signs with its own key.
string
required
The key of an enabled verification profile the source verifies for, such as RETAIL, PROFESSIONAL or a custom key. Every envelope the source delivers must carry this profile key.
string[]
Up to 10 whitelist IDs to bind. Duplicates are dropped. Omit it to bind none.

Response Fields

object
The response is sent with Cache-Control: no-store. The new source is written to the customer audit log as KYC_SOURCE_CREATED, with the fingerprint of its signing key.

Error Codes