📌
Red Flag A!ert
  • API Introduction
  • Authentication
  • Format & Pagination
  • Company
    • Company
    • Other Resources
    • Including additional resources
    • Attributes
    • Search
  • Company Resources
    • Addresses
    • Balance Sheet
    • Cashflow
    • Contacts
    • CCJs
    • Directorships
    • Filing History
    • Group Company
    • Mortgages
    • Parent Company
    • Previous Names
    • Profit & Loss
    • Ratio Analysis
    • Shareholders
    • Unpaid Debt
    • Unpaid Losses
  • Directors
    • Directorship
    • Attributes
    • Search
  • AML
    • Introduction
    • ID & AML Check
    • Charges
    • Search
    • Example Request
    • Response
  • Appendix
    • 1: Dissolution Status Codes
    • 2: SIC Sections
    • 3: RFA Health Ratings
Powered by GitBook
On this page
  • Example URL:
  • JSON Structure:

Was this helpful?

  1. Company

Company

PreviousFormat & PaginationNextOther Resources

Last updated 5 years ago

Was this helpful?

The core of the Red Flag API revolves around the 'companies' route. All searches directly relating to a company will be performed using this route.

For example, where a companies registered number is known, you can return the API's information about that company using the URL below.

Example URL:

https://api2.redflagalert.net/v4/companies/01777777/

JSON Structure:

All data is returned in the JavaScript Object Notation (JSON) format. The Red Flag Alert API is RESTful, and follows the JSON API () format.

{
	"data": {
		"relationships": [{
			"group-company": {
				"links": {
					"related": "https://api2.redflagalert.net/v4/companies/01777777/group-company"
				}
			}
		}, {
			"ccjs": {
				"links": {
					"related": "https://api2.redflagalert.net/v4/companies/01777777/ccjs/"
				}
			}
		}, {
			"addresses": {
				"links": {
					"related": "https://api2.redflagalert.net/v4/companies/01777777/addresses/"
				}
			}
		}, {
			"balance_sheet": {
				"links": {
					"related": "https://api2.redflagalert.net/v4/companies/01777777/balance-sheet/"
				}
			}
		}, {
			"shareholders": {
				"links": {
					"related": "https://api2.redflagalert.net/v4/companies/01777777/shareholders/"
				}
			}
		}, {
			"cashflow": {
				"links": {
					"related": "https://api2.redflagalert.net/v4/companies/01777777/cashflow/"
				}
			}
		}, {
			"contacts": {
				"links": {
					"related": "https://api2.redflagalert.net/v4/companies/01777777/contacts/"
				}
			}
		}, {
			"directorships": {
				"links": {
					"related": "https://api2.redflagalert.net/v4/companies/01777777/directorships/"
				}
			}
		}, {
			"profit_loss": {
				"links": {
					"related": "https://api2.redflagalert.net/v4/companies/01777777/profit-loss/"
				}
			}
		}, {
			"mortgages": {
				"links": {
					"related": "https://api2.redflagalert.net/v4/companies/01777777/mortgages/"
				}
			}
		}, {
			"ratio_analysis": {
				"links": {
					"related": "https://api2.redflagalert.net/v4/companies/01777777/ratio-analysis/"
				}
			}
		}, {
			"unpaid_losses": {
				"links": {
					"related": "https://api2.redflagalert.net/v4/companies/01777777/unpaid-losses/"
				}
			}
		}, {
			"filing-history": {
				"links": {
					"related": "https://api2.redflagalert.net/v4/companies/01777777/filing-history/"
				}
			}
		}],
		"attributes": {
			"dissolution_date": null,
			"website": "www.britishairways.com",
			"name": "BRITISH AIRWAYS PLC",
			"dissolution_status": null,
			"company_type": "plc",
			"company_number": "01777777",
			"company_aims": "A group engaged in the operation of international & domestic scheduled air services for carriage of passengers, freight & mail & the provision of ancillary services.",
			"legal_status": "Quoted",
			"rfa_rating": {
				"health_rating_code": 5,
				"credit_limit": 2000000,
				"short_code": "bronze",
				"trading_payment_parity": 31,
				"short_description": "Bronze",
				"long_description": "Bronze companies will be an average credit risk whose financial position and trading results are not as strong as Silver companies. They may even be new companies that have yet to file their accounts. It is likely that not all payments are made to terms and it is advisable to review any monitoring notices received on these companies"
			},
			"TPS": false,
			"auditor": "Ernst&YoungLLP",
			"incorporation_date": "1983-12-13",
			"sic_codes": [
				"62101",
				"62201",
				"63110",
				"63230"
			]
		},
		"type": "company",
		"id": "01777777",
		"links": {
			"self": "https://api2.redflagalert.net/v4/companies/01777777/"
		}
	}
}
http://jsonapi.org