#Getting started

THIS IS AN API DOCS EXAMPLE SITE

You can use this template and get the code at the following link: https://github.com/LarsWalraevens/api-docs-template

Tech stack: NextJS, TailwindCSS, TypeScript

~ Happy coding!


Overview

Our API allows your application to connect to internal application functionality.


Feedback

We value the feedback of our clients. We want to provide a developer experience that allows for a seamless integration, but we need your help! If you have any questions, comments, or ideas for our API, please contact support.

#Applicants

#Connect applicant emailPOST

https://api.example/api/v4/office/keys/{keyId}/invite/applicant
Description:Use this endpoint to connect the applicant and have your company marked for this applicant.
If the applicant is already connected, it will just mark your company to this applicant.

Parameters (body):

ApplicantEmail(Required)stringThis is the the email of the applicant.

LanguageIsoCode(Optional)stringThis is the 2-character ISO-code of a language. Options: EN, NL, FR

HTTP Status Codes (response):

200

A success result which also carries a response object.

261

The API key provided is invalid.

262

A 100 calls per minute threshold has been reached for your API key. Try to make sure you do not exceed this threshold.

265

A required body parameter is missing.

269

A bug report has been logged, no need to take action yourself.

400

An undocumented error has occured. A bug report has been logged, but we appreciate contacting us for providing more information.

401

You are unauthorized to use this endpoint.

500

An undocumented error happened. Please file a issue report HERE.

Body:

1 2 3 4 { "ApplicantEmail": "applicant@email.com", "LanguageIsoCode": "NL" }

C# Example:

1 2 3 4 5 6 7 8 9 10 11 12 13 public class ApiResponse { public int Status { get; } } /* ***** */ using (HttpClient client = new HttpClient()) { HttpResponseMessage authResponse = await client.PostAsync(new Uri(__ENDPOINT__), new StringContent(JsonConvert.SerializeObject(new { __BODY__ }), Encoding.UTF8, MediaTypeNames.Application.Json)); ApiResponse response = JsonConvert.DeserializeObject<ApiResponse>(await authResponse.Content.ReadAsStringAsync()); return response; }

200 Response:

1 2 3 { "Status": 200 }