GET, POST | /CompaniesHouse/{CompanyNumber} | ||
---|---|---|---|
GET, POST | /CompaniesHouse |
export class CompaniesHouseAddress
{
public address1?: string;
public address2?: string;
public address3?: string;
public city?: string;
public postcode?: string;
public constructor(init?: Partial<CompaniesHouseAddress>) { (Object as any).assign(this, init); }
}
export class CompaniesHouseIncorporationDate
{
public day?: number;
public month?: number;
public year?: number;
public constructor(init?: Partial<CompaniesHouseIncorporationDate>) { (Object as any).assign(this, init); }
}
export class CompaniesHouseShareHolderData
{
public title?: string;
public firstName?: string;
public middleNames?: string;
public lastName?: string;
public percentageOfVotingSharesOwned?: number;
public constructor(init?: Partial<CompaniesHouseShareHolderData>) { (Object as any).assign(this, init); }
}
export class CompaniesHouseDirectorsData
{
public title?: string;
public firstName?: string;
public middleNames?: string;
public lastName?: string;
public constructor(init?: Partial<CompaniesHouseDirectorsData>) { (Object as any).assign(this, init); }
}
export class CompaniesHouseData
{
public registeredName?: string;
public address?: CompaniesHouseAddress;
public dateOfIncorporation?: CompaniesHouseIncorporationDate;
public shareHolders?: CompaniesHouseShareHolderData[];
public directors?: CompaniesHouseDirectorsData[];
public constructor(init?: Partial<CompaniesHouseData>) { (Object as any).assign(this, init); }
}
export class CompaniesHouseResponse
{
/**
* Contains the companies house lookup result when successful.
*/
public Result: CompaniesHouseData;
/**
* Contains response status, details and errors.
*/
public ResponseStatus?: ResponseStatus;
public constructor(init?: Partial<CompaniesHouseResponse>) { (Object as any).assign(this, init); }
}
export class CompaniesHouseRequest
{
/**
* The registered company number.
*/
// @Required()
public CompanyNumber?: string;
/**
* The Csr of the application (if available).
*/
public Csr?: string;
public constructor(init?: Partial<CompaniesHouseRequest>) { (Object as any).assign(this, init); }
}
TypeScript CompaniesHouseRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /CompaniesHouse/{CompanyNumber} HTTP/1.1
Host: wpcdd-featuretest-ws.worldpay.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyNumber: String,
Csr: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { Result: { registeredName: String, address: { address1: String, address2: String, address3: String, city: String, postcode: String }, dateOfIncorporation: { day: 0, month: 0, year: 0 }, shareHolders: [ { title: String, firstName: String, middleNames: String, lastName: String, percentageOfVotingSharesOwned: 0 } ], directors: [ { title: String, firstName: String, middleNames: String, lastName: String } ] }, ResponseStatus: { ErrorCode: String, Message: String, StackTrace: String, Errors: [ { ErrorCode: String, FieldName: String, Message: String, Meta: { String: String } } ], Meta: { String: String } } }