{"_id":"55947b6e35f5671700942e7d","project":"543de77431ca981a00a700ec","category":{"_id":"55819c76a5474a0d00d945dc","version":"55819c76a5474a0d00d945db","pages":["55819c77a5474a0d00d945dd","55819c77a5474a0d00d945de","5588343ff348d60d00686205","5588344fb3bcf52b00513210","5588347beb5f2421003f9a3f","558834aaf348d60d0068620b","55888a2f8cb9c30d00b1effe","5591ad2cc671980d00543dd8","55947b6e35f5671700942e7d","5595b14ff4437019002888f0","5595b171608ea43900d8882c","55ad1fa818eefd0d0071d68c"],"project":"543de77431ca981a00a700ec","__v":11,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-15T03:18:12.343Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"user":"557b54fb9670ce0d0071b7bd","version":{"_id":"55819c76a5474a0d00d945db","__v":6,"project":"543de77431ca981a00a700ec","forked_from":"543de77431ca981a00a700ef","createdAt":"2015-06-17T16:12:38.031Z","releaseDate":"2015-06-17T16:12:38.031Z","categories":["55819c76a5474a0d00d945dc","55883498b3bcf52b00513212","5591ad23c671980d00543dd7","5591adfa342e980d006db03b","5591ae005781ae0d00236737","5595b4c4f4437019002888fb"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"__v":8,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-07-01T23:44:46.912Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"Error responses are largely based on standard HTTP error types, however, some errors may be more specific to Funding Circle's API strucutre. Responses for errors will include the following information and in the event of multiple errors a generic message will used with more specific information inside the main message.\n\n\nThe errors below are grouped by Error Number.\n\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"400 Errors\"\n}\n[/block]\nInvalid UUID\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"message\\\": \\\"ID is invalid\\\",\\n  \\\"error_details\\\": [\\n    {\\n      \\\"attribute\\\": \\\"id\\\",\\n      \\\"code\\\": \\\"invalid\\\",\\n      \\\"message\\\": \\\"is invalid\\\"\\n    }\\n  ],\\n  \\\"_links\\\": { },\\n  \\\"_embedded\\\": { }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\nInvalid Parameters \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"message\\\": \\\"Invalid param(s): asdf terms[]\\\",\\n  \\\"error_details\\\": [ ],\\n  \\\"_links\\\": { },\\n  \\\"_embedded\\\": { }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"401 Errors\"\n}\n[/block]\n\nNo Token Provided\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"message\\\": \\\"Not authenticated\\\"\\n}\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nLogin Failed\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"message\\\": \\\"Invalid username\\\\/password\\\"\\n}\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"403 Errors\"\n}\n[/block]\nListing has already been purchased\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"errors\\\": [\\n    {\\n      \\\"message\\\": \\\"Listing is not live\\\"\\n    }\\n  ]\\n}\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nListing is not live yet\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"errors\\\": [\\n    {\\n      \\\"message\\\": \\\"Listing is not live\\\"\\n    }\\n  ]\\n}\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nThere is not enough money available in your cash balance\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"errors\\\": [\\n    {\\n      \\\"message\\\": \\\"You do not have enough money to complete this order\\\"\\n    }\\n  ]\\n}\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"404 Errors\"\n}\n[/block]\nListing not found\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"errors\\\": [\\n    {\\n      \\\"message\\\": \\\"404 - LE error: Holding does not exist, or is not owned by the investor\\\"\\n    }\\n  ]\\n}\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"429 Error\"\n}\n[/block]\nToo many requests per second. Currently we allow for 40 requests per second. Please reduce the speed at which you are making calls to our API. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"500\"\n}\n[/block]\nUnexpected Character\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"JSON error (unexpected character): ȝ\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n* Application has an exception\n \nListing not found\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"message\\\": \\\"Listing not found\\\",\\n  \\\"error_details\\\": [ ],\\n  \\\"_links\\\": { },\\n  \\\"_embedded\\\": { }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"503 Errors\"\n}\n[/block]\nServer is down","excerpt":"","slug":"errors","type":"basic","title":"Errors"}
Error responses are largely based on standard HTTP error types, however, some errors may be more specific to Funding Circle's API strucutre. Responses for errors will include the following information and in the event of multiple errors a generic message will used with more specific information inside the main message. The errors below are grouped by Error Number. [block:api-header] { "type": "basic", "title": "400 Errors" } [/block] Invalid UUID [block:code] { "codes": [ { "code": "{\n \"message\": \"ID is invalid\",\n \"error_details\": [\n {\n \"attribute\": \"id\",\n \"code\": \"invalid\",\n \"message\": \"is invalid\"\n }\n ],\n \"_links\": { },\n \"_embedded\": { }\n}", "language": "json" } ] } [/block] Invalid Parameters [block:code] { "codes": [ { "code": "{\n \"message\": \"Invalid param(s): asdf terms[]\",\n \"error_details\": [ ],\n \"_links\": { },\n \"_embedded\": { }\n}", "language": "json" } ] } [/block] [block:api-header] { "type": "basic", "title": "401 Errors" } [/block] No Token Provided [block:code] { "codes": [ { "code": "{\n \"message\": \"Not authenticated\"\n}", "language": "text" } ] } [/block] Login Failed [block:code] { "codes": [ { "code": "{\n \"message\": \"Invalid username\\/password\"\n}", "language": "text" } ] } [/block] [block:api-header] { "type": "basic", "title": "403 Errors" } [/block] Listing has already been purchased [block:code] { "codes": [ { "code": "{\n \"errors\": [\n {\n \"message\": \"Listing is not live\"\n }\n ]\n}", "language": "text" } ] } [/block] Listing is not live yet [block:code] { "codes": [ { "code": "{\n \"errors\": [\n {\n \"message\": \"Listing is not live\"\n }\n ]\n}", "language": "text" } ] } [/block] There is not enough money available in your cash balance [block:code] { "codes": [ { "code": "{\n \"errors\": [\n {\n \"message\": \"You do not have enough money to complete this order\"\n }\n ]\n}", "language": "text" } ] } [/block] [block:api-header] { "type": "basic", "title": "404 Errors" } [/block] Listing not found [block:code] { "codes": [ { "code": "{\n \"errors\": [\n {\n \"message\": \"404 - LE error: Holding does not exist, or is not owned by the investor\"\n }\n ]\n}", "language": "text" } ] } [/block] [block:api-header] { "type": "basic", "title": "429 Error" } [/block] Too many requests per second. Currently we allow for 40 requests per second. Please reduce the speed at which you are making calls to our API. [block:api-header] { "type": "basic", "title": "500" } [/block] Unexpected Character [block:code] { "codes": [ { "code": "JSON error (unexpected character): ȝ", "language": "json" } ] } [/block] * Application has an exception Listing not found [block:code] { "codes": [ { "code": "{\n \"message\": \"Listing not found\",\n \"error_details\": [ ],\n \"_links\": { },\n \"_embedded\": { }\n}", "language": "json" } ] } [/block] [block:api-header] { "type": "basic", "title": "503 Errors" } [/block] Server is down