Getting Started

Quickstart

3 min read

Set up your first Renidly request in under five minutes. No SDK required — every endpoint is a plain HTTPS call you can fire from anything that speaks fetch.

Before you begin

Create an account. Sign up at renidly.com/signup if you don't already have one.
Get your API key. Open Workspace → API Keys, copy your key, and store it somewhere safe.
Pick something to look up. A handle, an entity ID, an organization slug. You can also just use the sample identifier in the snippets below.

1Make your first request

Send a real request

Every endpoint is served from https://renidly.com/api/v2/. Authenticate with the X-renidly-apikeyheader. That's it.

curl https://renidly.com/api/v2/person/enrich?handle=jane-doe \
  -H "X-renidly-apikey: $RENIDLY_API_KEY"

2Read the response

Every response looks the same

Every Renidly endpoint returns a five-field JSON envelope. Two fields matter for almost every integration: success tells you whether the call worked, and data holds the actual payload.

{
  "success": true,
  "statusCode": 200,
  "message": "Data retrieved successfully",
  "errors": null,
  "data": { ... }
}

The full envelope contract — what each field means, when errors is populated, and how to handle it — is documented in Response Envelope.

3Handle errors predictably

Failed validation is free

If the request is malformed — missing a required parameter, wrong type, unknown identifier — the body comes back with success: false and the reason in message. No credits are deducted on validation failures. See Errors & Retries for the two failure shapes and retry strategy.

Next steps

Authentication — production-grade key handling.
Your first API call — parsing a real response field-by-field.
Which endpoint should I use? — pick the right surface.
Production checklist — what to verify before going live.

← Previous

Overview

Authentication