{"_id":"5a3a740454faf60030b6318b","project":"56e29a8dd3b68d0e00b48ffa","version":{"_id":"56e29a8dd3b68d0e00b48ffd","hasReference":true,"project":"56e29a8dd3b68d0e00b48ffa","__v":15,"hasDoc":true,"createdAt":"2016-03-11T10:14:37.460Z","releaseDate":"2016-03-11T10:14:37.460Z","categories":["56e29a8ed3b68d0e00b48ffe","56eb917a2e58011700afdfcc","56eb92252109011700f3ba5e","5704d4af849f721900f27835","57052a31473f900e004d5d54","5715222811537f19006aab2d","5715b57b810df00e00cc7832","5715baa9810df00e00cc7837","57180ed83a17770e009a7322","571810273a17770e009a7325","579b22d3f4ad7b190094b60e","584538ecba4f1c0f0096925e","586bb88e5602870f00ae7177","5a70407fb0a01400369583c5","5ace359e40606a0003eac1de"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"category":{"_id":"56eb917a2e58011700afdfcc","version":"56e29a8dd3b68d0e00b48ffd","pages":[],"project":"56e29a8dd3b68d0e00b48ffa","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-03-18T05:26:18.963Z","from_sync":false,"order":2,"slug":"company-information","title":"Companies"},"user":"5795d43eb9ee2d0e00df357a","__v":1,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-12-20T14:30:28.882Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"code":"<?php\n// Example assumes Composer is in use with GuzzleHttp as the API library.\nrequire_once(\"vendor/autoload.php\");\nuse GuzzleHttp\\Client;\n\n// Production environment endpoint\n// $api_base_uri = 'https://api.single-invoice.co/v2.0';\n\n// Sandbox environment endpoint\n$api_base_uri = 'https://api-demo.single-invoice.co/v2.0';\n\n// Create a client and provide a base URL\n$client = new Client([ \n\t'timeout' \t=> 8.0,\n\t'verify'\t=> true,\n\t'debug'\t\t=> true\n]);\n\ntry\n{\n\t// POST the account creation request with the required parameters\n\t$response = $client->request('GET', $api_base_uri.\"/transactor/$id/externalids\", [\n\t\t'headers' => [ 'apikey' => 'wAuYQcPsO88Fu4YyCa8klBidGksGg0LHACtl8EzK5ORdzG3RmuyvRqH5tDSqXiox' ],\n\t]);\n\n\t// Check the status code returned by the call\n\t$statusCode = $response->getStatusCode();\n\n\t// Get the data\n\t$data = json_decode($response->getBody(), true);\n}\ncatch (GuzzleHttp\\Exception\\ClientException $e) {\n\t$response = $e->getResponse();\n\t$responseBodyAsString = $response->getBody()->getContents();\n}","language":"php"},{"code":"curl -H \"apikey: CdF49I89tjCSoYHXh9tCXQxzNuY1C4oJM4SS7q1c\" -H \"Content-Type: application/json\" https://api-demo.single-invoice.co/v2.0/transactor/fr/siren/348920596 -v ","language":"curl"}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"[\n    {\n        \"Id\": \"123456\",\n        \"Service\": \"eulerid\",\n        \"CountryCode\": \"FR\"\n    },\n    {\n        \"Id\": \"654321111\",\n        \"Service\": \"siren\",\n        \"CountryCode\": \"fr\"\n    },\n]","name":""},{"status":404,"language":"json","code":"{\n  \"Code\":5001,\n  \"Message\":\"Company not found.\",\n  \"Description\":null,\"DocUrl\":\"TBD\"\n}"},{"status":408,"language":"json","code":"{\n\t\"message\" : \"Expired date stamp\",\n  \"docUrl\": \"https://armadill.io/docs/authentication\"\n}"},{"code":"{\n\t\"code\":400,\n  \"message\":\"The value 'zzz' is not valid for Guid.\",\n  \"docUrl\":\"https://singleinvoice.co/docs/errors#section-missing_param\"\n}","language":"text","status":400}]},"auth":"required","params":[{"_id":"5717b1e29c10132400d0ba39","ref":"","in":"path","required":true,"desc":"The Single-Invoice.co ID for a given transactor","default":"","type":"string","name":"id"},{"_id":"579e5730f8b52d0e0043fd19","ref":"","in":"header","required":true,"desc":"Your Coverage API Key, in the HTTP request headers.","default":"","type":"string","name":"apikey"}],"url":"/transactor/:id/externalids"},"isReference":true,"order":5,"body":"This method allows you to retrieve the External IDs that are linked to a specific Single-Invoice.co company.\n\nIt will return an array of items including the ID, service code, and country code for each linked External ID. \n\nAn External ID is typically the unique ID in some sort of company registry - for example, French companies each have a unique SIREN code. \n\nNote that a list of the supported service codes is available with the [Services Listing](doc:services-listing) endpoint.","excerpt":"Returns information about a company specified by an external service type and an external service ID","slug":"get-external-ids","type":"endpoint","title":"Get Company External IDs"}

getGet Company External IDs

Returns information about a company specified by an external service type and an external service ID

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The Single-Invoice.co ID for a given transactor

Headers

apikey:
required
string
Your Coverage API Key, in the HTTP request headers.

Examples


Result Format


Documentation

This method allows you to retrieve the External IDs that are linked to a specific Single-Invoice.co company. It will return an array of items including the ID, service code, and country code for each linked External ID. An External ID is typically the unique ID in some sort of company registry - for example, French companies each have a unique SIREN code. Note that a list of the supported service codes is available with the [Services Listing](doc:services-listing) endpoint.