API Documentation - fetchdocs

Documentation

Quick Start

Environments

Webhooks

Document Provisioning

Migrate connections to fetchdocs

Trigger a manual fetch

API Reference

Create a new connection (step 1)

Trigger a manual fetch

post

Get the connection information

get

Get connection step 2 fields

get

Update a connection (step 2)

put

Lazyload field options

Create a new identity

post

Search for an identity

Links

Imprint · Privacy Policy

Create a new identity

post

/v1/identities

🔐 Authentication

X-API-KEY API key of the environment

Header parameter: X-API-KEY

📤 Request

Content Type: application/json

name string

The name of the identity.

Example: John Doe

client_identifier string required

Identifier of the identity in the client app. It is used to identify the identity and must be unique within an environment.

Example: 43y34h

Request Example

{
    "name": "John Doe",
    "client_identifier": "43y34h"
}
            

📥 Response

201 Created

Content Type:

data object

Object that represents the identity.

object

uuid string

The UUID of the identity.

Example: 3598b23c-31db-4be9-9e6b-6aa1d5b60335

name string

The name of the identity.

Example: Max Mustermann

client_identifier string

Identifier of the identity provided by the client. Most time this is an account number or ID used to identify the user in the client's system.

Example: 123456

401 Unauthorized Error

Content Type:

The error response is returned when the client is not authenticated. The client must provide a valid authentication key to access the resource.

error string

The error code is a machine readable code describing the error.

Example: API_KEY_MISSING_OR_INVALID

message string

The error message is a human readable message describing the error. It is mainly used for understanding the error by developers. It is not meant to be shown to real users.

Example: API key is missing or invalid.

suggestion string

For many errors we provide suggestions how you can resolve the error on your own.

Example: Either you didn't pass an API key or it is invalid. You can find or create a new API key in the environments section. It must be passed as X-API-Key header.

trace_id string

The trace ID is a unique identifier for the request. It is used to trace the request through the system. Please provide the trace_id when reporting an error to our support team.

Example: 1b935d50c2393af77b1dc92e675876a83f92ffd6

help string

This parameter provides a way to contact support. It is mainly used for developers. It is not meant to be shown to real users.

Example: If you need help, email [email protected] and include the following Trace-ID in your message: 1b935d50c2393af77b1dc92e675876a83f92ffd6.

422 Unprocessable Entity

Content Type:

The error response is returned when the client has provided invalid data in the request.

error string

The error code is a machine readable code describing the error.

Example: VALIDATION_ERROR

message string

The error message is a human readable message describing the error. It is mainly used for understanding the error by developers. It is not meant to be shown to real users.

Example: The identity uuid field is required. | The return url field is required.

suggestion string

For many errors we provide suggestions how you can resolve the error on your own.

Example: There might be some parameters are missing or the values of parameters you have passed are invalid. Please check the payload and make sure it conforms with the rules mentioned in API doc.

trace_id string

The trace ID is a unique identifier for the request. It is used to trace the request through the system. Please provide the trace_id when reporting an error to our support team.

Example: 1b935d50c2393af77b1dc92e675876a83f92ffd6

errors object

The errors object contains a list of fields with their corresponding error messages.

Example: { "identity_uuid": [ "The identity uuid field is required." ], "return_url": [ "The return url field is required." ] }

help string

This parameter provides a way to contact support. It is mainly used for developers. It is not meant to be shown to real users.

Example: If you need help, email [email protected] and include the following Trace-ID in your message: 1b935d50c2393af77b1dc92e675876a83f92ffd6.

500 Internal Server Error

Content Type:

The error response is returned when an unknown server error occurred. Unfortunately, there is nothing you can do to resolve the error on your own. Please try again later or contact support and provide the trace_id.

error string

The error code is a machine readable code describing the error.

Example: UNKNOWN_SERVER_ERROR

message string

The error message is a human readable message describing the error. It is mainly used for understanding the error by developers. It is not meant to be shown to real users.

Example: An unknown server error occurred. Please try again later or contact support.

suggestion string

For many errors we provide suggestions how you can resolve the error on your own.

Example: Either you didn't pass an API key or it is invalid. You can find or create a new API key in the environments section. It must be passed as X-API-Key header.

trace_id string

The trace ID is a unique identifier for the request. It is used to trace the request through the system. Please provide the trace_id when reporting an error to our support team.

Example: 1b935d50c2393af77b1dc92e675876a83f92ffd6

help string

This parameter provides a way to contact support. It is mainly used for developers. It is not meant to be shown to real users.

Example: If you need help, email [email protected] and include the following Trace-ID in your message: 1b935d50c2393af77b1dc92e675876a83f92ffd6.

Response Examples

{
  "data": {
    "uuid": "3598b23c-31db-4be9-9e6b-6aa1d5b60335",
    "name": "Max Mustermann",
    "client_identifier": "123456"
  }
}
    

{ "error": "API_KEY_MISSING_OR_INVALID", "message": "API key is missing or invalid.", "suggestion": "Either you didn't pass an API key or it is invalid. You can find or create a new API key in the environments section. It must be passed as X-API-Key header.", "trace_id": "1b935d50c2393af77b1dc92e675876a83f92ffd6", "help": "If you need help, email [email protected] and include the following Trace-ID in your message: 1b935d50c2393af77b1dc92e675876a83f92ffd6." }

{ "error": "VALIDATION_ERROR", "message": "The identity uuid field is required. | The return url field is required.", "suggestion": "There might be some parameters are missing or the values of parameters you have passed are invalid. Please check the payload and make sure it conforms with the rules mentioned in API doc.", "trace_id": "1b935d50c2393af77b1dc92e675876a83f92ffd6", "errors": { "identity_uuid": [ "The identity uuid field is required." ], "return_url": [ "The return url field is required." ] }, "help": "If you need help, email [email protected] and include the following Trace-ID in your message: 1b935d50c2393af77b1dc92e675876a83f92ffd6." }

{ "error": "UNKNOWN_SERVER_ERROR", "message": "An unknown server error occurred. Please try again later or contact support.", "suggestion": "Either you didn't pass an API key or it is invalid. You can find or create a new API key in the environments section. It must be passed as X-API-Key header.", "trace_id": "1b935d50c2393af77b1dc92e675876a83f92ffd6", "help": "If you need help, email [email protected] and include the following Trace-ID in your message: 1b935d50c2393af77b1dc92e675876a83f92ffd6." }

Body Parameters