ThirdPartyIdentification | Sage Active Developer

Quick Links

Accounts Accounting Entries Products Customers Sales quotes Sales invoices Suppliers Purchase invoices

Available for FR legislation only

HTTP	Operation	Type	Object	DTO Why-DTOs?
POST	Read	⚙️ ActionThe action resource represents a type of object that differs from standard queries or mutations. For a query, it returns a result already prepared by Sage Active, with no possibility to add filters, sorts, or explore the data further, or it executes an action (e.g., sending an email). For a mutation, it executes a specific business action, also carried out by Sage Active, which will impact the data (e.g., generating a credit note from an invoice). (Query)	`thirdPartyIdentification`	`thirdPartyIdentificationGLDtoInput`

Description

The Sirene API allows querying the Sirene register of companies and establishments, managed by INSEE.
It relies on the official French public registry SIRENE and therefore returns French companies only.

The service uses the French public API Sirene open data
Returns identification data for French companies only.
Useful when creating customers or suppliers, to help find a company and retrieve identification data, including the address.
Can also be used to retrieve establishments by business activity (APE / NAF), city, or street, for prospecting and qualification purposes.
Supports main and advanced filtering.
Allows limiting the number of returned records.

Action: specific behavior

This operation is an ⚙️ ActionThe action resource represents a type of object that differs from standard queries or mutations.

For a query, it returns a result already prepared by Sage Active, with no possibility to add filters, sorts, or explore the data further, or it executes an action (e.g., sending an email).

For a mutation, it executes a specific business action, also carried out by Sage Active, which will impact the data (e.g., generating a credit note from an invoice)., not a standard query.

As such, it does not support configurable filters, sorting, or pagination.
Filtering is entirely driven by the input parameters, which also allow limiting the number of results (100 records returned by default, with a maximum of 1000).
Some filter criteria enable more advanced searches. For example, using the address filter makes it possible to find an establishment located at 31 rue des Cosmonautes by simply providing a partial value such as rue cosmo.

Input Parameters

Main parameters:
- Name: Legal or commercial name of the entity.
- Siret: Unique French establishment identifier (14 digits).
Advanced parameters (optional and independent from the main parameters):
- Address: Street or address information.
- City: City name.
- ZipCode: Postal code.
- NafCode: French business activity code (APE / NAF).

All parameters can be used independently or combined, depending on the search needs.

How to use the Third Party Identification service?

GraphQL Query

query($input: ThirdPartyIdentificationDtoInput!) {
  thirdPartyIdentification(input: $input) {
    businessName
    siretSiren
    address
    city
    zipCode
    nafApeCode
    vatNumber
  }
}

Simple filter

{
  "input": {
    "name": "ALPHA"
  }
}

Advanced filter

{
  "input": {
    "address": "Boulevard des Tests",
    "city": "Lyon",
    "searchLimit": 10
  }
}

Example Response

{
  "data": {
    "thirdPartyIdentification": [
      {
        "businessName": "ALPHA SERVICES FRANCE",
        "siretSiren": "12345678900011",
        "address": "12 Boulevard des Tests",
        "city": "Lyon",
        "zipCode": "69003",
        "nafApeCode": "47.91A",
        "vatNumber": "FR12123456789"
      },
      {
        "businessName": "ALPHA DISTRIBUTION",
        "siretSiren": "98765432100022",
        "address": "14 Boulevard des Tests",
        "city": "Lyon",
        "zipCode": "69003",
        "nafApeCode": "46.90Z",
        "vatNumber": "FR34987654321"
      }
    ]
  }
}

thirdPartyIdentification Input parameters

Fields	Type	Description	Length
name *The value of the field or object is mandatory	String	Legal or commercial name of the entity See InfoAdditional information is available in the Info block below	200
siret *The value of the field or object is mandatory	String	French establishment identifier (14 digits) See InfoAdditional information is available in the Info block below	14
address	String	Street or address filter	200
city	String	City name	100
zipCode	String	Postal code	10
nafCode	String	French activity code (APE / NAF)	5
searchLimit	Int	Maximum number of returned records requested (default 100, max 1000)

Info

Name: Legal or commercial name of the entity (contains search).
Siret: French identifier, either a SIRET (14 digits) or a SIREN (9 digits).

thirdPartyIdentification Response

Fields	Type	Description
businessName	String	Legal or business name
siretSiren	String	SIRET (14 digits) or SIREN (9 digits) depending on the match
address	String	Address
city	String	City
zipCode	String	Postal code
nafApeCode	String	French activity code (NAF / APE)
vatNumber	String	French identification vat number