Remote Personal Details API is one of 101 APIs that Remote publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Personal Details. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
2 operations
across 2 paths,
and defines 26 schemas.
It is described by OpenAPI 3.0.0, at version 0.1.0.
Requests are made against 2 base URLs: https://gateway.remote.com/, https://gateway.remote-sandbox.com/.
2 operations2 paths26 schemas2 PUT
Metadata
The identity and technical contract details declared by the specification.
Remote Personal Details API declares
7 security schemes
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
It accepts HTTP bearer tokens (ClientToken).
It accepts HTTP bearer tokens (CustomerAPIToken).
It supports OAuth 2.0 (OAuth2) using the authorizationCode and clientCredentials flows, exposing 77 scopes.
It supports OAuth 2.0 (OAuth2Assertion) using the clientCredentials flow, exposing 21 scopes.
It supports OAuth 2.0 (OAuth2AuthorizationCode) using the authorizationCode flow, exposing 73 scopes.
It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow, exposing 18 scopes.
By default, every request must be authenticated.
BasicAuth — Authenticate using the basic authentication for partners. Use the CLIENTID as login and CLIENTSECRET as password.
ClientToken — Authenticate a partner using only the the provided clienttoken. This authentication method only allows accessing marketing endpoints.
CustomerAPIToken — Authenticate using API Key generated by the customer in their Integration Settings page.
OAuth2 — Authenticate using OAuth 2.0 protocol.
OAuth2Assertion — Authenticate as the employee using the urn:ietf:params:oauth:grant-type:jwt-bearer grant in the OAuth2 protocol.
OAuth2AuthorizationCode — Authenticate as the token authorizer using authorizationcode / refreshtoken grants in the OAuth 2.0 protocol.
OAuth2ClientCredentials — Authenticate using clientcredentials grant in the OAuth 2.0 protocol.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are Employment (45 properties), NullableCountry (11 properties), OnboardingTasks (9 properties), File (5 properties). Each schema is shown below with its type and property counts.
ParameterError
object
3 properties3 required
UserStatus
string
The status of the user account associated with this employment. - active: The user account is active and the user can log in. - created: The user account has b…
ProvisionalStartDate
string
Indicates the expected start date of the employee or contractor. Required for employees, but optional for contractors. Date format is in ISO8601 without the ti…
EmploymentPersonalDetailsParams
object
Employment personal details.
1 property1 required
ConflictResponse
object
Returned when the request conflicts with the current state of a resource (HTTP 409). For example, trying to create a resource that already exists or performing…
1 property
UnauthorizedResponse
object
Returned when the request does not include valid authentication credentials. Ensure you are passing a valid OAuth2 access token or API token in the Authorizati…
1 property1 required
UnprocessableEntityResponse
object
BadRequestResponse
object
Returned when the request is malformed or contains invalid parameters. The message may be a simple string or a structured object with a code and detailed messa…
Employment
object
Complete information of an employment, including all onboarding task statuses, country-specific form data (address, contract, administrative, etc.), and contra…
45 properties28 required
ShortId
string
Unique short identifier for the employment, automatically generated and visible in select areas of the Remote platform. Not intended as a replacement for the e…
ActionError
object
3 properties3 required
ForbiddenResponse
object
Returned when the authenticated user or token does not have permission to perform the requested action. Check that the token has the required OAuth2 scopes and…
1 property1 required
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
File
object
A file associated with an employment, such as a contract, tax form, or identity document.
5 properties4 required
CountrySubdivision
object
A subdivision of a supported country on Remote
3 properties1 required
EmploymentDetailsOnlyResponse
object
Response containing only the updated details struct plus base employment fields (id, status, type, updatedat, userstatus). Exactly one of the details propertie…
1 property1 required
PricingPlanDetails
object
Selected type of payment.
1 property1 required
DateTimeIso8601
string
UTC date time in [ISO 8601][] format. [ISO 8601]: https://en.wikipedia.org/wiki/ISO8601
EmploymentSeniorityDate
string
The date the employee first started working for your company. If you don’t include a seniority date, the employee’s start date with Remote will be deemed as th…
EmploymentResponse
object
Response containing the full employment record after an update operation.
1 property1 required
TaskDescription
object
Description and status of an onboarding task.
2 properties
NullableCountry
object
A supported country on Remote
11 properties3 required
EmploymentStatus
string
The current status of the employment record. - active: The employee is fully onboarded and actively working. - created: The employment has been created but onb…
EmploymentLifecycleStage
string
The stage of employment lifecycle. When it's onboarded means the employee is ready to commence or has already commenced.
TooManyRequestsResponse
object
Returned when the API rate limit has been exceeded (HTTP 429). Wait before retrying. Check the Retry-After response header for the recommended wait time.
1 property
OnboardingTasks
object
All tasks that need to be completed before marking the employment as ready
9 properties9 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
