POST
https://api.milda.ai/v1/risk-assessment/candidatesRisk Candidates
application/json01
Description
Risk Assessment — Candidates
POST /v1/risk-assessment/candidates
Step 1 of risk assessment. Resolves a company id to the candidate companies used for the data endpoints. If you already pass the exact target company id, a single matching candidate is returned.
Request
company_id(required) — Company ID.
Response
List of candidates:
- candidate_id — pass this to the data endpoints below.
- registration_number, name, country_code, url, age, size
Returns 204 No Content if nothing matches.
Flow & credits
Pick a candidate_id and call any of the data endpoints:
financials, ownership, report. This candidates step is free.
02
Headers
nameinreqdescription
tokenheaderone ofYour API token, sent as "token: YOUR_API_TOKEN". Send this or Authorization.
Authorizationheaderone ofThe same token in the standard form, sent as "Authorization: Bearer YOUR_API_TOKEN" (the word Bearer, a space, then your token). Send this or token.
03
Request body
CompanyRequestCompanyRequesttypereq1 fields
company_idstringyesCompany ID.
04
Responses
200 Successful Response422 Validation Error
Returns a JSON array. Each item:
RiskCandidatetype7 fields
candidate_idstringCandidate ID. Pass this to the data endpoints.
namestring | nullCompany name.
registration_numberstring | nullOfficial company registration number.
country_codestring | nullTwo-letter ISO 3166-1 alpha-2 country code.
urlstring | nullCompany website URL.
agestring | nullCompany age category.
sizestring | nullCompany size category by employee count.