onfido.services.rehive.io Open in urlscan Pro
2606:4700:10::ac43:2857 Public Scan

Back to summary
URL:
https://onfido.services.rehive.io/
Submission: On March 11 via automatic, source certstream-suspicious (March 11th 2024, 8:11:30 am UTC) — Scanned from DE
Form analysis
0 forms found in the DOM

Text Content

 * activate
   * postActivate service
 * admin
   * getRetrieve company
   * putUpdate company
   * patchPartially update company
   * getList document types
   * postCreate document type
   * getRetrieve document type
   * putadmin_document_types_update
   * patchadmin_document_types_partial_update
 * deactivate
   * postDeactivate service
 * onfido
   * postReceive Onfido webhook
 * webhook
   * postReceive Platform webhook

API docs by Redocly



ONFIDO SERVICE API (1 (1))

Download OpenAPI specification:Download

Rehive Support: support@rehive.com URL: https://rehive.com/support/ Terms of
Service


The Onfido Service API is used for managing KYC in Rehive using Onfido.

Docs portal


ACTIVATE


ACTIVATE SERVICE

AUTHORIZATIONS:

None

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



token
required
string



RESPONSES

200
post/activate/
https://onfido.services.rehive.io/api/activate/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "token": "string"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
{
 * "status": "sucess"

}


ADMIN


RETRIEVE COMPANY

AUTHORIZATIONS:

apiAuth


RESPONSES

200
get/admin/company/
https://onfido.services.rehive.io/api/admin/company/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
    * "onfido_api_key": "string",
    * "onfido_webhook_id": "string"
   
   }

}


UPDATE COMPANY

AUTHORIZATIONS:

apiAuth

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



onfido_api_key
string or null <= 300 characters



RESPONSES

200
put/admin/company/
https://onfido.services.rehive.io/api/admin/company/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "onfido_api_key": "string"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
    * "onfido_api_key": "string",
    * "onfido_webhook_id": "string"
   
   }

}


PARTIALLY UPDATE COMPANY

AUTHORIZATIONS:

apiAuth

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



onfido_api_key
string or null <= 300 characters



RESPONSES

200
patch/admin/company/
https://onfido.services.rehive.io/api/admin/company/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "onfido_api_key": "string"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
    * "onfido_api_key": "string",
    * "onfido_webhook_id": "string"
   
   }

}


LIST DOCUMENT TYPES

AUTHORIZATIONS:

apiAuth

QUERY PARAMETERS

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.


RESPONSES

200
get/admin/document-types/
https://onfido.services.rehive.io/api/admin/document-types/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "count": 123,
    * "next": "http://api.example.org/accounts/?page=4",
    * "previous": "http://api.example.org/accounts/?page=2",
    * "results": [
       * {
          * "id": "string",
          * "platform_type": "string",
          * "onfido_type": "national_identity_card",
          * "side": "front",
          * "created": 0,
          * "updated": 0
         
         }
      
      ]
   
   }

}


CREATE DOCUMENT TYPE

AUTHORIZATIONS:

apiAuth

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



onfido_type
required
string
Enum: "national_identity_card" "driving_licence" "passport" "voter_id"
"work_permit"
 * national_identity_card - National Identity Card
 * driving_licence - Driving Licence
 * passport - Passport
 * voter_id - Voter Id
 * work_permit - Work Permit

platform_type
required
string <= 64 characters

side
string
Enum: "front" "back"
 * front - Front
 * back - Back


RESPONSES

201
post/admin/document-types/
https://onfido.services.rehive.io/api/admin/document-types/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "platform_type": "string",
 * "onfido_type": "national_identity_card",
 * "side": "front"

}


RESPONSE SAMPLES

 * 201

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "platform_type": "string",
    * "onfido_type": "national_identity_card",
    * "side": "front",
    * "created": 0,
    * "updated": 0
   
   }

}


RETRIEVE DOCUMENT TYPE

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$



RESPONSES

200
get/admin/document-types/{identifier}/
https://onfido.services.rehive.io/api/admin/document-types/{identifier}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "platform_type": "string",
    * "onfido_type": "national_identity_card",
    * "side": "front",
    * "created": 0,
    * "updated": 0
   
   }

}


ADMIN_DOCUMENT_TYPES_UPDATE

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



onfido_type
required
string
Enum: "national_identity_card" "driving_licence" "passport" "voter_id"
"work_permit"
 * national_identity_card - National Identity Card
 * driving_licence - Driving Licence
 * passport - Passport
 * voter_id - Voter Id
 * work_permit - Work Permit

platform_type
required
string <= 64 characters

side
string
Enum: "front" "back"
 * front - Front
 * back - Back


RESPONSES

200
put/admin/document-types/{identifier}/
https://onfido.services.rehive.io/api/admin/document-types/{identifier}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "platform_type": "string",
 * "onfido_type": "national_identity_card",
 * "side": "front"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "platform_type": "string",
    * "onfido_type": "national_identity_card",
    * "side": "front",
    * "created": 0,
    * "updated": 0
   
   }

}


ADMIN_DOCUMENT_TYPES_PARTIAL_UPDATE

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

identifier
required
string^([a-zA-Z0-9\_\-]+)$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



platform_type
string <= 64 characters

onfido_type
string
Enum: "national_identity_card" "driving_licence" "passport" "voter_id"
"work_permit"
 * national_identity_card - National Identity Card
 * driving_licence - Driving Licence
 * passport - Passport
 * voter_id - Voter Id
 * work_permit - Work Permit

side
string
Enum: "front" "back"
 * front - Front
 * back - Back


RESPONSES

200
patch/admin/document-types/{identifier}/
https://onfido.services.rehive.io/api/admin/document-types/{identifier}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "platform_type": "string",
 * "onfido_type": "national_identity_card",
 * "side": "front"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "platform_type": "string",
    * "onfido_type": "national_identity_card",
    * "side": "front",
    * "created": 0,
    * "updated": 0
   
   }

}


DEACTIVATE


DEACTIVATE SERVICE

AUTHORIZATIONS:

None

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



token
required
string

purge
boolean
Default: false



RESPONSES

200
post/deactivate/
https://onfido.services.rehive.io/api/deactivate/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "token": "string",
 * "purge": false

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
{
 * "status": "sucess"

}


ONFIDO


RECEIVE ONFIDO WEBHOOK

AUTHORIZATIONS:

None

PATH PARAMETERS

company_id
required
string^\w+$


REQUEST BODY SCHEMA: APPLICATION/JSON



payload
required
object



RESPONSES

201
post/onfido/webhook/{company_id}/
https://onfido.services.rehive.io/api/onfido/webhook/{company_id}/


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
Expand all Collapse all
{
 * "payload": {
    * "property1": null,
    * "property2": null
   
   }

}


RESPONSE SAMPLES

 * 201

Content type
application/json
Copy
{
 * "status": "sucess"

}


WEBHOOK


RECEIVE PLATFORM WEBHOOK

AUTHORIZATIONS:

None

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



company
required
string

data
required
object

event
required
string
Enum: "document.create" "document.update" "user.create" "user.update"
 * document.create - Document Create
 * document.update - Document Update
 * user.create - User Create
 * user.update - User Update

id
required
string



RESPONSES

200
post/webhook/
https://onfido.services.rehive.io/api/webhook/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
 * "id": "string",
 * "event": "document.create",
 * "company": "string",
 * "data": {
    * "property1": null,
    * "property2": null
   
   }

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
{
 * "status": "sucess"

}
onfido.services.rehive.io Open in urlscan Pro 2606:4700:10::ac43:2857 Public Scan

Form analysis 0 forms found in the DOM

Text Content

onfido.services.rehive.io Open in urlscan Pro
2606:4700:10::ac43:2857 Public Scan

Form analysis
0 forms found in the DOM
