{"_id":"5b59b0827f39c90003a96fa9","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":"58bedd212710c31b004150db","githubsync":"","__v":9,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-07-26T11:29:06.259Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"[\n    {\n        \"Id\": \"ffa425d4-f6ce-452c-b727-e4734f820c95\",\n        \"Name\": \"EULER HERMES GROUP\",\n        \"Address\": {\n            \"StreetNumber\": \"1\",\n            \"StreetName\": \"PL DES SAISONS\",\n            \"PostCode\": \"92048\",\n            \"City\": \"COURBEVOIE\",\n            \"StateCode\": \"92\",\n            \"CountryCode\": \"FR\",\n            \"Type\": \"main\"\n        },\n        \"PhoneNumber\": \"0147203050\",\n        \"LegalFormCode\": \"SA16\",\n        \"ExternalIds\": [\n            {\n                \"ExternalId\": \"3750941\",\n                \"ExternalService\": \"eulerid\"\n            },\n            {\n                \"ExternalId\": \"552040594\",\n                \"ExternalService\": \"SIREN\"\n            },\n            {\n                \"ExternalId\": \"F0214113\",\n                \"ExternalService\": \"TIID\"\n            },\n            {\n                \"ExternalId\": \"381556158\",\n                \"ExternalService\": \"DUN\"\n            },\n            {\n                \"ExternalId\": \"54552040594\",\n                \"ExternalService\": \"TVAFR\"\n            },\n            {\n                \"ExternalId\": \"202018003\",\n                \"ExternalService\": \"HRM\"\n            }\n        ]\n    }\n]","name":""},{"status":400,"language":"json","code":"{\n\t\"message\" : \"Missing parameter: :parameter\",\n  \"docUrl\": \"https://single-invoice.co/docs/errors\"\n}","name":""},{"status":401,"language":"json","code":"{\n\t\"message\" : \"Bad authentication information\",\n  \"docUrl\": \"https://single-invoice.co/docs/errors\"\n}"},{"status":408,"language":"json","code":"{\n\t\"message\" : \"Expired date stamp\",\n  \"docUrl\": \"https://single-invoice.co/docs/errors\"\n}"},{"status":404,"name":"Not found","language":"json","code":"{ \n\t\"code\":404,\n  \"message\":\"Resource not found\",\n  \"docUrl\":\"https://single-invoice.co/docs/errors\"\n}"}]},"method":"get","examples":{"codes":[{"code":"<?php\n\n$request = new HttpRequest();\n$request->setUrl('https://api.single-invoice.co/v2/transactors');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData(array(\n  'countrycode' => 'FR',\n  'name' => 'Euler%20Hermes',\n  'streetnumber' => '1',\n  'streetName' => 'Place%20des%20saisons',\n  'postcode' => '92048',\n  'city' => 'COURBEVOIE',\n  'legalform' => 'SA16',\n  'phonenumber' => '0147203050'\n));\n\n$request->setHeaders(array(\n  'Postman-Token' => 'e7631296-ca18-4ebe-ac5a-3db04e530bcc',\n  'Cache-Control' => 'no-cache',\n  'apikey' => 'xxx'\n));\n\ntry {\n  $response = $request->send();\n\n  echo $response->getBody();\n} catch (HttpException $ex) {\n  echo $ex;\n}","language":"php"}]},"auth":"required","params":[{"_id":"571467ae9261900e00baff57","ref":"","in":"path","required":false,"desc":"The name of the company to search for. Name can contain special characters but must be URL encoded.","default":"","type":"string","name":"name"},{"_id":"56e9026ec88bf80e00f8bf3a","ref":"","in":"path","required":false,"desc":"The ISO_3166-1_alpha-2 country code","default":"","type":"string","name":"countrycode"},{"_id":"57051ce4473f900e004d5d04","ref":"","in":"query","required":false,"desc":"The [page number](pagination) to return, if there are more than 50 results","default":"1","type":"int","name":"page"},{"_id":"579e56ca8cc49e0e00dea8cc","ref":"","in":"header","required":true,"desc":"Your Coverage API Key, in the HTTP request headers.","default":"","type":"string","name":"apikey"},{"_id":"5a5f451a2cc4c20012bdc2f8","ref":"","in":"query","required":false,"desc":"Filter on companies that match this specific legalForm","default":"","type":"string","name":"legalForm"},{"_id":"5a5f451a2cc4c20012bdc2f7","ref":"","in":"query","required":false,"desc":"Filter on companies in this city. Note that linked companies (e.g., subsidiaries) may be included in results with non-matching cities.","default":"","type":"string","name":"city"},{"_id":"5a6092d81264b100264224f2","ref":"","in":"query","required":false,"desc":"Filter on company phone number.","default":"","type":"string","name":"phoneNumber"},{"_id":"5a65b146e9f8b3003ad033fb","ref":"","in":"query","required":false,"desc":"Filter on companies by this street name.","default":"","type":"string","name":"streetName"},{"_id":"5a65b146e9f8b3003ad033fa","ref":"","in":"query","required":false,"desc":"Filter on companies by this street number.","default":"","type":"string","name":"streetNumber"},{"_id":"5aa865ab0f44d5001239cadf","ref":"","in":"query","required":false,"desc":"Filter by post code / zip code","default":"","type":"string","name":"postCode"}],"url":"/transactors"},"isReference":true,"order":0,"body":"This method allows you to search the Single-Invoice.co company database to find a transactor using only their company name. This will allow you to discover their Single-Invoice.co ID, which will in turn allow you to obtain quotes for coverage.\n\nThe endpoint takes two primary inputs:\n\n* Country code: the country in which the company resides\n* Company name: the name of the company\n\nAdditionally (as with any Single-Invoice.co query that can return multiple responses) you can also supply a 'page' parameter to allow pagination of results. \n\nFilters are also available for other fields, which are passed as query string parameters. Filters include city, street name, street number, and phone number. \n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"A note on filtering\",\n  \"body\": \"Please note that due to the underlying back end service we use for searching companies, filters can appear to be quite \\\"fuzzy\\\" - for example, if you filter on \\\"Paris\\\" as a city, you may get results which include companies in other cities. \\n\\nThis can happen if there companies are linked through some mechanism in our search back end (for example, if one company is a subsidiary of the other).\"\n}\n[/block]\nIf the search is successful, the endpoint will return JSON containing general identifying information about the transactor (including the Single-Invoice.co ID, company name, address and phone number).","excerpt":"Find a company record by name and country code.","slug":"transactors-search","type":"endpoint","title":"Search Company by Name (new)"}

getSearch Company by Name (new)

Find a company record by name and country code.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

name:
string
The name of the company to search for. Name can contain special characters but must be URL encoded.
countrycode:
string
The ISO_3166-1_alpha-2 country code

Query Params

page:
integer1
The [page number](pagination) to return, if there are more than 50 results
legalForm:
string
Filter on companies that match this specific legalForm
city:
string
Filter on companies in this city. Note that linked companies (e.g., subsidiaries) may be included in results with non-matching cities.
phoneNumber:
string
Filter on company phone number.
streetName:
string
Filter on companies by this street name.
streetNumber:
string
Filter on companies by this street number.
postCode:
string
Filter by post code / zip code

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 using only their company name. This will allow you to discover their Single-Invoice.co ID, which will in turn allow you to obtain quotes for coverage. The endpoint takes two primary inputs: * Country code: the country in which the company resides * Company name: the name of the company Additionally (as with any Single-Invoice.co query that can return multiple responses) you can also supply a 'page' parameter to allow pagination of results. Filters are also available for other fields, which are passed as query string parameters. Filters include city, street name, street number, and phone number. [block:callout] { "type": "warning", "title": "A note on filtering", "body": "Please note that due to the underlying back end service we use for searching companies, filters can appear to be quite \"fuzzy\" - for example, if you filter on \"Paris\" as a city, you may get results which include companies in other cities. \n\nThis can happen if there companies are linked through some mechanism in our search back end (for example, if one company is a subsidiary of the other)." } [/block] If the search is successful, the endpoint will return JSON containing general identifying information about the transactor (including the Single-Invoice.co ID, company name, address and phone number).