Skip to main content
Base URL
Each endpoint adds its path to the base URL. For example, Create an enrichment is POST https://api-bc.userecord.io/api/v1/partner/enrichments, and List results is GET https://api-bc.userecord.io/api/v1/partner/enrichments/{enrichment_id}/results. You need two things: your key id and your secret. The signature, timestamp and Idempotency-Key are generated for you. Copy the call() helper from Authentication first: the code samples on each endpoint page use it.

Try it

Every endpoint page has a Try it button. Enter your key id in x-api-key and your secret in x-secret-key, fill the request and press Send. x-secret-key is only a form field: the page signs the request in your browser and removes the secret before sending. See Why does Try it say x-secret-key?.
Create a campaign really contacts the numbers you send. Use a TEST key.

On each endpoint page

  • Scope: the scope the key needs. Any one listed is enough.
  • Idempotency-Key: whether the endpoint needs one, accepts one, or ignores it. Try it makes one for you.
  • Responses: the success answer and the errors specific to that endpoint. Errors any endpoint can return, such as 401, 429 and 500, are listed in Errors.

Endpoints

Results are read with GET /results: each one is final as soon as it appears.