{"_id":"5717b160681bb41900fc5753","editedParams":true,"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"},"user":"56e62c36cfa58f0e00eafcfb","__v":4,"editedParams2":true,"githubsync":"","parentDoc":null,"project":"56e29a8dd3b68d0e00b48ffa","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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-20T16:42:08.985Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"Id\": \"6d568a15-f99c-4b4b-9143-fbda98b0b32e\",\n    \"Name\": \"ACME INC\",\n    \"Address\": {\n        \"StreetNumber\": \"1\",\n        \"StreetName\": \"EXAMPLE STREET\",\n        \"PostCode\": \"92048\",\n        \"City\": \"PARIS\",\n        \"StateCode\": \"92\",\n        \"CountryCode\": \"FR\"\n    },\n    \"PhoneNumber\": \"+33415175815\",\n    \"LegalFormCode\": \"SA16\"\n}","name":""},{"name":"","status":400,"language":"json","code":"{\n\t\"message\" : \"Missing parameters\",\n  \"docUrl\": \"https://armadill.io/docs/errors#section-missing_param\"\n}"},{"language":"json","status":401,"code":"{\n\t\"message\" : \"Bad authentication information\",\n  \"docUrl\": \"http://docs.armadill.io/docs/errors#section-bad-authentication-information\"\n}"},{"status":404,"language":"json","code":"{\n\t\"message\" : \"Resource not found\",\n  \"docUrl\": \"https://armadill.io/docs/errors#section-resource_not_found\"\n}"},{"status":408,"language":"json","code":"{\n\t\"message\" : \"Expired date stamp\",\n  \"docUrl\": \"https://armadill.io/docs/authentication\"\n}"}]},"settings":"","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/FR/SIRET/41773899400058\", [\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"}]},"method":"get","auth":"required","params":[{"_id":"57adb9023f00b90e00b7c950","ref":"","in":"path","required":true,"desc":"Country code for the service.","default":"","type":"string","name":"countrycode"},{"_id":"5717b1e29c10132400d0ba3a","ref":"","in":"path","required":true,"desc":"The external service identifer code (for example, SIREN or SIRET)","default":"","type":"string","name":"service"},{"_id":"5717b1e29c10132400d0ba39","ref":"","in":"path","required":true,"desc":"The ID of the transactor in an external system","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/:countrycode/:service/:id"},"isReference":true,"order":3,"body":"This method allows you to search the Single-Invoice.co company database to find a transactor through a variety of \"external IDs\". This will allow you to discover their Single-Invoice.co ID, which will in turn allow you to obtain quotes for coverage. \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[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"For users that are famililar with searching via the Euler Hermes ID, these are accessible with the service listing type 'eulerid' (e.g., http://api.single-invoice.co/v2.0/transactor/:countrycode/eulerid/:id).\",\n  \"title\": \"Searching via Euler Hermes ID\"\n}\n[/block]\nA list of the supported registry services is made available through the [Services Listing](doc:services-listing) endpoint. \n\nThe endpoint takes three inputs: \n* Country code: the country in which the company resides\n* Service: the service identifier (as noted in the [Services Listing](doc:services-listing))\n* Id: the identifier for the external service\n\nIf the search is successful, the endpoint will return JSON containing general identifying information about the transactor (including company name, address and phone number).","excerpt":"Returns information about a company specified by an external service type and an external service ID","slug":"by-service-id","type":"endpoint","title":"Search Company By External ID"}

getSearch Company By External ID

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

countrycode:
required
string
Country code for the service.
service:
required
string
The external service identifer code (for example, SIREN or SIRET)
id:
required
string
The ID of the transactor in an external system

Headers

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

Examples


Result Format


Documentation

This method allows you to search the Single-Invoice.co company database to find a transactor through a variety of "external IDs". This will allow you to discover their Single-Invoice.co ID, which will in turn allow you to obtain quotes for coverage. An external ID is typically the unique ID in some sort of company registry - for example, French companies each have a unique SIREN code. [block:callout] { "type": "info", "body": "For users that are famililar with searching via the Euler Hermes ID, these are accessible with the service listing type 'eulerid' (e.g., http://api.single-invoice.co/v2.0/transactor/:countrycode/eulerid/:id).", "title": "Searching via Euler Hermes ID" } [/block] A list of the supported registry services is made available through the [Services Listing](doc:services-listing) endpoint. The endpoint takes three inputs: * Country code: the country in which the company resides * Service: the service identifier (as noted in the [Services Listing](doc:services-listing)) * Id: the identifier for the external service If the search is successful, the endpoint will return JSON containing general identifying information about the transactor (including company name, address and phone number).