Developer documentation

Your first API call, made simple.

Find the essentials for connecting Papaye API to your application. You can also start in Playground without writing code.

Quick start

Make your first call in three steps.

  1. 1
    Create an account and organization

    Onboarding automatically prepares your workspace.

  2. 2
    Generate a test key

    Copy it immediately: it will only be shown once.

  3. 3
    Call an endpoint

    Replace VOTRE_CLE_API in the example below.

curl "https://neopay-api-staging.onrender.com/v1/companies/search?q=neo&limit=10" \
  -H "Authorization: Bearer VOTRE_CLE_API"

Authentication

Add your key to every request.

All routes /v1 use Bearer authentication. A test key starts with nd_test_ and a production key with nd_live_.

const response = await fetch(
  "https://neopay-api-staging.onrender.com/v1/companies/search?q=neo",
  { headers: { Authorization: "Bearer VOTRE_CLE_API" } }
);

const result = await response.json();

Reference

Nine services in three categories.

Companies

Find and view companies and their establishments.

GET/v1/companies/searchSearch companies
GET/v1/companies/{siren}View a company
GET/v1/companies/{siren}/establishmentsList establishments
GET/v1/companies/{siren}/summaryGet a summary

Addresses

Search, autocomplete, or geolocate an address.

GET/v1/addresses/searchSearch addresses
GET/v1/addresses/autocompleteAutocomplete input
GET/v1/addresses/reverseReverse geocode

Property

Explore transactions and local market indicators.

GET/v1/properties/transactionsSearch transactions
GET/v1/properties/market-summaryGet a market summary

Common format

Predictable responses.

A successful response always contains success, data and meta. Lists also include a pagination.

400Invalid parameters
401Invalid or expired key
404Data not found
429Limit reached
503Source unavailable
504Source timed out

Security

Keep your key secret.

  • Store the key in an environment variable.
  • Never include it in a repository, screenshot, or public message.
  • Use a different key for each application.
  • Immediately revoke any key that may have been compromised.