Hi,
I need sample data for testing below api call integration, I have been using below API’s:
Can you please provide above information for which i can get valid response? Your help will be appreciated.
It would be great if CH maintained an “examples list” (even better if it was live…) but from my own info:
Answer to 1): you can find up-to-date examples at:
http://download.companieshouse.gov.uk/en_pscdata.html
This data is in json format, each example has:
When I checked there examples of all types e.g. natural persons, corporate and legal persons. I didn’t do a complete check to see if super-secure resources are listed here though…(see answer to 3)
Some more info about formats etc. is in this post:
Note that the “streaming API” never appeared however.
Answer to 2): some example company numbers (tested just now, have had statements for a while now):
SC549056 - no-individual-or-entity-with-signficant-control
10380561 - no-individual-or-entity-with-signficant-control
00871954 - no-individual-or-entity-with-signficant-control
SC012574 - psc-details-not-confirmed
00582065 - psc-details-not-confirmed
Answer to 3): some example company numbers (tested just now, have had these for a while now). I only have two examples (think I found these on this forum - CH had provided these to someone when asked):
02443921
08084186
Chris
@voracityemail:
#2: what is the company id and what are the statement id?
I tried with given data as follows:
Company Id=SC549056
Statement Id= no-individual-or-entity-with-signficant-control
and same was followed for all the examples you provided. But none of them got any response. So Is it anything i am doing wrong here?
#3: Same follows here, what is the company id and super_secure_id out of which the examples you mentioned.
Thanks for your reply.
I’ve given examples of what I do below. I’ve shown this using cUrl on the command line but the REST URI is the same for other methods. I’ve included links so you can also see the data returned on the web in CH Beta.
If these don’t help you’ll need to give some more information about what you’re actually doing and what specifically you want to achieve. When you say “I tried with given data as follows” what was the REST URI (e.g. what endpoint / parameters were you trying)? When you say “But none of them got any response” what does that mean? An http error? No http error but nothing in the JSON body returned? etc.
For 2) if you use the “List the company persons with significant control statements” endpoint: (see https://developer.companieshouse.gov.uk/api/docs/company/company_number/persons-with-significant-control-statements/listPersonsWithSignificantControlStatements.html )
curl -u"my-api-key-goes-here:" "https://api.companieshouse.gov.uk/company/SC549056/persons-with-significant-control-statements"
The JSON response should be like:
{
“start_index”: 0,
“items”: [ {
“kind”: “persons-with-significant-control-statement”,
“statement”: “no-individual-or-entity-with-signficant-control”,
“etag”: “189067174ec5b114054a4249536f95e4d321773c”,
“notified_on”: “2016-11-01”,
“links”: { “self”: “/company/SC549056/persons-with-significant-control-statements/-NXsaUt_99YynFxAmDQ16ozDOHg” }
} ],
“active_count”: 1, “items_per_page”: 25,
“total_results”: 1, “ceased_count”: 0,
“links”: { “self”: “/company/SC549056/persons-with-significant-control-statements” }
}
You asked about the statement-id parameter. That would be used if you wanted to get a specific statement - but you’d need to find this first. You can do this for a given company number by using the “List the company persons with significant control statements” endpoint. I wouldn’t normally need to do this since the same information is already given in the previous endpoint e.g. the “text” of the statement is conveyed by the constant given in the member “statement”: “no-individual-or-entity-with-signficant-control”. If you wanted you can use the “links”: { “self”: “/company/SC549056/persons-with-significant-control-statements/-NXsaUt_99YynFxAmDQ16ozDOHg” } member to look up the entry for a particular statement - in this example you’d use:
curl -u"my-api-key-goes-here:" "https://api.companieshouse.gov.uk/company/SC549056/persons-with-significant-control-statements/-NXsaUt_99YynFxAmDQ16ozDOHg"
So the “self” member in the internal “links” member gives you the appropriate “get statement” endpoint (see https://developer.companieshouse.gov.uk/api/docs/company/company_number/persons-with-significant-control-statements/statement_id/getPersonsWithSignificantControlStatement.html )
You can see this example Beta (note that the part after “.gov.uk” has the same format as the REST API endpoint fragment):
For 3)
if you use the “List the company persons with significant control” endpoint: (see https://developer.companieshouse.gov.uk/api/docs/company/company_number/persons-with-significant-control/listPersonsWithSignificantControl.html )
curl -u"my-api-key-goes-here:" "https://api.companieshouse.gov.uk/company/02443921/persons-with-significant-control"
The JSON response should be like:
{
“items_per_page”: 25, “start_index”: 0, “active_count”: 3
“links”: { “self”: “/company/02443921/persons-with-significant-control” },
“ceased_count”: 0, “total_results”: 3,
“items”: [
{
“description”: “super-secure-persons-with-significant-control”,
“kind”: “super-secure-person-with-significant-control”,
“etag”: “0913bc1ce0f0833295114c4b89e997f89ba85445”,
“links”: { “self”: “/company/02443921/persons-with-significant-control/super-secure/NcZQQA0LMrXYV1u0fGRHLrGIL_I” }
},
{
“links”: { “self”: “/company/02443921/persons-with-significant-control/super-secure/JFL2DKSDumug-XdKsxukUZWRZYw” },
“description”: “super-secure-persons-with-significant-control”,
“kind”: “super-secure-person-with-significant-control”,
“etag”: “cd218d85b3989d9c19ec517b276b20ad03d64907”
},
{ … I’ve edited out the non-super-secure entry you also get }
],
}
Again, if you wanted you can use the links → self member on either of these to look up them individually (e.g. this is the super-secure-id bit you mentioned). I’d have no reason to - you gain no extra info at the moment - but if you liked you can take:
“links”: { “self”: “/company/02443921/persons-with-significant-control/super-secure/JFL2DKSDumug-XdKsxukUZWRZYw” }
And call this endpoint (see https://developer.companieshouse.gov.uk/api/docs/company/company_number/persons-with-significant-control/super-secure/super_secure_id/getSuperSecurePersonWithSignificantControl.html ):
curl -u"my-api-key-goes-here:" "https://api.companieshouse.gov.uk/company/02443921/persons-with-significant-control/super-secure/JFL2DKSDumug-XdKsxukUZWRZYw"
JSON response:
{
“links”: { “self”: “/company/02443921/persons-with-significant-control/super-secure/JFL2DKSDumug-XdKsxukUZWRZYw” },
“description”: “super-secure-persons-with-significant-control”,
“kind”: “super-secure-person-with-significant-control”,
“etag”: “cd218d85b3989d9c19ec517b276b20ad03d64907”
}
In Beta: https://beta.companieshouse.gov.uk/company/02443921/persons-with-significant-control
Note the two “Protected person with significant control” entries.
@voracityemail: Thank you so much for your detailed guidance. I got the successful response for all three API’s. Thanks once again.