REremote-com
Identity Verification

Get Employment Profile

Gets necessary information to perform the identity verification of an employee.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:read and all:write work too.

Token typeCategoryRead only ScopeWrite only Scope (read access implicit)
Company-scoped access tokenManage employment documents (employment_documents)View identity verification (identity_verification:read)Manage identity verification (identity_verification:write)
Company-scoped access token (assertion)Manage employment documents (employment_documents)View identity verification (identity_verification:read)Manage identity verification (identity_verification:write)
Customer API tokenManage employment documents (employment_documents)View identity verification (identity_verification:read)Manage identity verification (identity_verification:write)
get/v1/identity-verification/{employment_id}

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/identity-verification/{employment_id}
  • Auth
    • OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: identity_verification:read
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:write
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: identity_verification:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:write
    • or HTTP bearer

Path parameters

employment_idstring required

Employment ID

Response

Success

Example response

{
  "data": {
    "identity_verification_data": {
      "contract_id": "1c130827-f95c-4495-b7cb-5876dce686b8",
      "employment_document": {
        "id": "f4e2f1fe-2056-4d9f-b9e0-ea322b781eb7",
        "inserted_at": "2021-01-01T00:00:00Z",
        "name": "2024-05-29_Hero8r5-document.pdf",
        "sub_type": "identity_verification",
        "type": "mobility"
      },
      "employment_image": {
        "id": "f4e2f1fe-2056-4d9f-b9e0-ea322b781eb7",
        "inserted_at": "2021-01-01T00:00:00Z",
        "name": "2024-05-29_Hero8r5-image.png",
        "sub_type": "identity_verification",
        "type": "mobility"
      },
      "status": "pending"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.