### Start ReuseID Onboarding Response Example

Source: https://developer.signicat.com/docs/reuseid/quick-start-guides/identity-proofing

Example JSON response after successfully starting a ReuseID onboarding operation. It contains essential details like status, transaction ID, user ID, and the activation code.

```json
{
  "data": {
    "status": "Pending",
    "transactionId": "94099e7e-b391-45fb-9404-b54682f16d03",
    "userId": "7f1994f0-5fed-4e0f-a8e2-64da520a09cb",
    "activationCode": "2005468691",
    "dossierId": "41ff5755-4ece-42cf-b7de-3efd0181ba88",
    "processId": "8be8325a-9654-4165-a56f-0d1ccdc3bd3e"
  }
}
```

--------------------------------

### Start Capture Flow Response Example

Source: https://developer.signicat.com/docs/id-document-and-biometric-verification/assure-api/integration-steps

An example of the response received when starting a capture flow in a web context. This response contains a URL that should be used to redirect the end-user to initiate the identity verification.

```json
{
    "url": "https://assure-demo.sandbox.signicat.com/capture/#/artifact=67fylnrx975e2jvbk8d410vknfnz122lllhclumxuvo6z5man2"
}
```

--------------------------------

### Run Java Sample Project

Source: https://developer.signicat.com/cs/enterprise/docs/electronic-signatures/guides/quick-start/java

This command executes the built Java sample project, which is packaged as a JAR file. The application will start, and you can access the signing order via a provided URL. Ensure the JAR file is in the current directory.

```bash
java -jar target/signapi-demo-1.0-SNAPSHOT-jar-with-dependencies.jar
```

--------------------------------

### Example Authorisation Request (GET)

Source: https://developer.signicat.com/cs/enterprise/docs/authentication/about-oidc

Demonstrates a typical GET request to the Signicat authorisation endpoint. It includes essential parameters like response_type, scope, client_id, state, redirect_uri, and optional parameters such as acr_values and multiple login_hint values.

```http
GET /oidc/authorize?
    response_type=code
    &scope=openid profile email
    &client_id=client01
    &state=af=ifjsldkj
    &redirect_uri=https://server.example.com:443/oidcclient/redirect/client01
    &acr_values=urn:signicat:oidc:method:scid-proof
    &login_hint=deviceId-92855960
    &login_hint=authType-email


```

--------------------------------

### Start ReuseID Onboarding Request Body (ReadID Provider)

Source: https://developer.signicat.com/docs/reuseid/quick-start-guides/identity-proofing

Example request body for initiating ReuseID onboarding with the ReadID provider. This is a simpler configuration focusing only on the provider.

```json
{
  "provider" : "readid"
}
```

--------------------------------

### Get Access Token

Source: https://developer.signicat.com/cs/enterprise/docs/electronic-signatures/guides/quick-start/java

Fetches an access token required for authenticating API requests.

```APIDOC
## Authentication

### Description
This section details how to obtain an access token for authenticating with the Signicat API using client credentials grant.

### Method
POST (Implicitly via ScribeJava)

### Endpoint
https://preprod.signicat.com/oidc/token

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
Client credentials are used in the OAuth 2.0 client credentials grant flow.
- **clientId** (string) - Required - Your application's client ID.
- **clientSecret** (string) - Required - Your application's client secret.

### Request Example
```java
String clientId = "test.demo.microservices";
String clientSecret = "BVn1suS2TkKCMWejcTmxgW-Dmuul0wKSZ59liKa0bW4";

OAuth20Service service = new ServiceBuilder(clientId)
        .apiSecret(clientSecret)
        .defaultScope("client.signature")
        .build(new DefaultApi20() {

            @Override
            public String getAccessTokenEndpoint() {
                return "https://preprod.signicat.com/oidc/token";
            }

            @Override
            protected String getAuthorizationBaseUrl() {
                return null;
            }
        });

return service.getAccessTokenClientCredentialsGrant().getAccessToken();
```

### Response
#### Success Response (200)
- **accessToken** (string) - The obtained access token for API authentication.

#### Response Example
```json
{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
```
```

--------------------------------

### Build Java Project with Maven

Source: https://developer.signicat.com/cs/enterprise/docs/electronic-signatures/guides/quick-start/java

This command builds the Java project using Maven, packaging it into an executable JAR file. Ensure Maven is installed and configured correctly in your environment.

```bash
mvn package
```

--------------------------------

### POST /onboarding/start

Source: https://developer.signicat.com/docs/reuseid/quick-start-guides/identity-proofing

Initiates the ReuseID onboarding process. It defaults to 'signicatvideoid' as the provider if not specified.

```APIDOC
## POST /onboarding/start

### Description
Starts the ReuseID onboarding process. If the provider is not explicitly set in the request body, it defaults to `signicatvideoid`.

### Method
POST

### Endpoint
/onboarding/start

### Parameters
#### Query Parameters
None

#### Request Body
- **externalRef** (string) - Optional - An external reference for the onboarding process.
- **provider** (string) - Optional - The identity provider to use (e.g., `signicatvideoid`, `readid`). Defaults to `signicatvideoid`.
- **videoidProviderOptions** (object) - Optional - Options specific to the `signicatvideoid` provider.
  - **docTypes** (array of integers) - Optional - A list of document types to be used.
  - **defaultId** (integer) - Optional - The default document type ID.

### Request Example
```json
{
  "externalRef": "000-000-000",
  "provider" : "signicatvideoid",
  "videoidProviderOptions" : {
    "docTypes" : [138,169,147,245,277],
    "defaultId" : 138
  }
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains details of the initiated onboarding.
  - **status** (string) - The current status of the onboarding (e.g., "Pending").
  - **transactionId** (string) - A unique identifier for the transaction.
  - **userId** (string) - The user ID associated with the onboarding.
  - **activationCode** (string) - The code required to activate the onboarding on the device.
  - **dossierId** (string) - The ID of the dossier.
  - **processId** (string) - The ID of the process.

#### Response Example
```json
{
  "data": {
    "status": "Pending",
    "transactionId": "94099e7e-b391-45fb-9404-b54682f16d03",
    "userId": "7f1994f0-5fed-4e0f-a8e2-64da520a09cb",
    "activationCode": "2005468691",
    "dossierId": "41ff5755-4ece-42cf-b7de-3efd0181ba88",
    "processId": "8be8325a-9654-4165-a56f-0d1ccdc3bd3e"
  }
}
```
```

--------------------------------

### SAML 2.0 Setup

Source: https://developer.signicat.com/docs/eid-hub/quick-start

Information on setting up a SAML 2.0 connection by exchanging XML metadata files with Signicat.

```APIDOC
### SAML 2.0

This guide explains how you can exchange XML metadata files with Signicat to set up a SAML 2.0 connection. To learn more about integrating using SAML 2.0, see Set up SAML.
```

--------------------------------

### Start Signing Operation (POST /credentials/devices/signatures)

Source: https://developer.signicat.com/apis/reuseid-openapi

This snippet demonstrates how to initiate a signing process on an end-user's device using the Signicat API. It includes an example request body with user and device identifiers, operation properties like session timeout and pre-operation context, and the expected successful response (201 Created) which contains a transaction ID and operation state.

```json
{
  "userId": "0e99b25c-abde-4553-973b-8d94d49cd87e",
  "device": {
    "id": "20874199-f4d1-4e9d-86ee-dd4a46030acb"
  },
  "operationProperties": {
    "sessionTimeout": "90000",
    "preOperationContext": {
      "title": "Consent Sign",
      "content": "Pay me 100$",
      "mimeType": "text/plain"
    }
  }
}

```

```json
{
  "transactionId": "7daa489e-6b35-46ca-83a4-1bba2ea35f68",
  "accountId": "a-sdge-Abcdefghijk123456789",
  "state": "PENDING",
  "operationProperties": {
    "preOperationContext": {
      "title": "Consent Sign",
      "content": "Pay me 100$",
      "mimeType": "text/plain"
    },
    "pushSent": false,
    "sessionExpiryTime": "2022-08-19T06:04:53.123Z",
    "sendPush": false
  },
  "created": "2022-08-19T06:03:23.123Z",
  "device": {
    "id": "20874199-f4d1-4e9d-86ee-dd4a46030acb",
    "name": "sampleDevice"
  },
  "user": {
    "externalRef": "Empl10300469",
    "id": "0e99b25c-abde-4553-973b-8d94d49cd87e"
  }
}

```

--------------------------------

### Get Session Status Request Example

Source: https://developer.signicat.com/identity-methods/personalausweis/integration/rest-api

This example demonstrates how to construct a GET request to retrieve the status of a specific authentication session using its unique ID. The session ID is obtained from the initial session creation response.

```http
GET https://api.signicat.com/auth/rest/sessions/c99e17e2-b124-f549-a88c-408f8e555d31
```

--------------------------------

### Start Capture Flow Request Body

Source: https://developer.signicat.com/docs/id-document-and-biometric-verification/services/capture

Example of the request body for the 'Start capture flow' service, showing provider and SDK configuration.

```APIDOC
## POST /capture/start

### Description
Initiates the capture flow, allowing integration with various providers and SDKs.

### Method
POST

### Endpoint
/capture/start

### Parameters
#### Request Body
- **providers** (array) - Required - An array of provider configurations.
- **sdk** (string) - Optional - Specifies the SDK to use ('native' or 'capture'). Defaults to 'native' if not set.
- **redirectUrl** (string) - Required - The URL to redirect to after the capture process.

### Request Example
```json
{
  "providers": [
    {}
  ],
  "sdk": "native",
  "redirectUrl": "https://customer.site.com"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success status of the request.
- **data** (object) - Contains relevant data for the capture session.
```

--------------------------------

### Initialize .NET Project for Authorization Code Flow

Source: https://developer.signicat.com/docs/eid-hub/oidc/code-examples/authorization-code-flow

Commands to create a new .NET solution and add an empty web project for the authorization code flow guide. Requires .NET Core SDK.

```bash
mkdir SignicatQuickStartGuide
cd .\SignicatQuickStartGuide\
dotnet new sln

dotnet new web --name AuthorizationCodeFlowGuide
dotnet sln .\SignicatQuickStartGuide.sln add .\AuthorizationCodeFlowGuide\
```

--------------------------------

### Provider-Specific Data Example (Onfido)

Source: https://developer.signicat.com/docs/id-document-and-biometric-verification/services/process

This JSON object illustrates the structure of provider-specific data within the 'Get Process' response, using Onfido as an example. It includes details like facial similarity results and image integrity.

```json
{
    "providerSpecific": {
        "facialSimilarity": {
            "result": "clear",
            "imageIntegrity": "clear",
            "faceComparison": "clear",
            "visualAuthenticity": "clear",
            "similarityScore": "high"
        }
    }
}
```

--------------------------------

### Prefilling User Information with login_hint

Source: https://developer.signicat.com/identity-methods/sms-otp/setup/oidc

This example shows how to use the `login_hint` query parameter to prefill the end-user's phone number in the authentication URL. This simplifies the user journey by bypassing manual phone number entry. Ensure the phone number is correctly URL-encoded.

```url
https://example.sandbox.signicat.com/auth/open/connect/authorize?  
&client_id=dev-test-client-123  
&response_type=code  
&redirect_uri=https://example.com/callback  
&scope=openid%20idp-id%20phone  
&login_hint=mobile:%2B447700900000  

```

--------------------------------

### Get Matching Configuration Response Example (JSON)

Source: https://developer.signicat.com/apis/id-document-and-biometric-verification

This JSON object represents a matching configuration. It includes the configuration details, such as fields for matching, normalization, and algorithms, along with creation and update timestamps.

```json
{
  "configuration": {
    "fields": [
      {
        "id": "fieldId1",
        "sourceField": "firstName",
        "targetField": "lastName",
        "normalization": "upper",
        "algorithm": "levenshtein"
      }
    ]
  },
  "id": "Configuration1",
  "createdAt": "2021-10-04T09:35:19Z",
  "updatedAt": "2021-10-04T09:35:19Z"
}
```

--------------------------------

### Get Organization by ID (SCIM v2)

Source: https://developer.signicat.com/broker/ownidp/scim-api-1

Example of a GET request to retrieve a specific organization by its unique identifier using the SCIM v2 protocol.

```HTTP
https://example.tenant.com/ciam/1.0/scim/v2/Organizations/f39322c6-7234-478a-a976-9a7409c0b085
```

--------------------------------

### GET Request Example for External ID

Source: https://developer.signicat.com/apis/id-document-and-biometric-verification

This snippet shows a GET request to retrieve a process's external ID. It includes a sample JSON response containing the external ID.

```json
{
  "externalId": "2822984e-fa4d-46a9-b4cd-de47d5050cc0"
}
```

--------------------------------

### Get ReuseID Onboarding Result Response Example

Source: https://developer.signicat.com/docs/reuseid/quick-start-guides/identity-proofing

Example JSON response when retrieving the result of a ReuseID onboarding process. It includes final status, user details, and various IDs related to the transaction.

```json
{
  "data": {
    "transactionId": "e35ebbf7-9631-4966-9762-ae939c80eda1",
    "userId": "a1e26081-35b4-4557-a46a-ef50bc91672f",
    "activationCode": "8954685641",
    "deviceId": "b1g73121-55c4-9238-l39j-ek60dc91872g",
    "proofingId": "30745db7-4403-4403-aa7e-cb35435ee565",
    "dossierId": "3d563ac4-9d26-4a6a-b58d-5a29cacfe015",
    "processId": "2f54b0a4-1a77-42e2-98d8-369116ef2055",
    "status": "Completed",
    "userData": {
      "firstName": "JANE",
      "lastName": "SMITH",
      "dateOfBirth": "1990-01-01",
      "gender": "F",
      "nationality": "NOR"
    }
  }
}
```

--------------------------------

### Clone Repository using Git

Source: https://developer.signicat.com/docs/data-verification/code-examples

This snippet shows the command to clone the sample application repository from GitHub to your local machine. It's the initial step to get the project files.

```bash
git clone https://github.com/signicat/sample-data-verification
```

--------------------------------

### Install Signicat Express SDK for .NET

Source: https://developer.signicat.com/cs/express/docs/signature/guides/code-example

Instructions for installing the Signicat Express SDK, which simplifies the integration of signature functionality in .NET applications. This SDK can be installed using either the 'dotnet add package' command or via NuGet Package Manager.

```bash
# Install via dotnet
dotnet add package Signicat.SDK
dotnet restore
```

```powershell
# Or install via NuGet
PM> Install-Package Signicat.SDK
```

--------------------------------

### Create Account - Response Sample

Source: https://developer.signicat.com/apis/account-management

This JSON sample illustrates a successful response after creating an account. It returns the details of the newly created account, including its unique ID, name, creation and modification timestamps, organization details, sandbox status, region, cloud provider, and enabled status.

```json
{
  "id": "a-ppge-ovC1eMDgt0hkgqZUSaPh",
  "name": "My Account",
  "createdDate": "",
  "lastModifiedDate": "2022-05-11T11:28:59Z",
  "isSoftDeleted": null,
  "softDeletedAt": null,
  "organization": {
    "id": "o-p-0TgcUq7CylltM7OkwB4t",
    "name": "My Organization",
    "url": "https://api.signicat.com/account-management/organizations/-p-0TgcUq7CylltM7OkwB4t"
  },
  "isSandbox": false,
  "region": "EU",
  "cloud": "GCP",
  "enabled": true,
  "isDeleteProtected": false,
  "products": [
    "auth",
    "auth-nbid",
    "auth-sbid",
    "sign",
    "sign-nbid"
  ]
}
```

--------------------------------

### Example Authorization Request URL

Source: https://developer.signicat.com/docs/eid-hub/oidc/oidc-implementation

An example of a GET request to the authorization endpoint for initiating an end-user authentication flow. It includes parameters like client_id, redirect_uri, response_type, scope, state, and code challenge for security.

```http
https://<YOUR_SIGNICAT_DOMAIN>/auth/open/connect/authorize?client_id=CLIENT_ID&redirect_uri=REDIRECT_URI&response_type=code&scope=openid%20profile&state=123&code_challenge=ABC123&code_challenge_method=S256&response_mode=query
```

--------------------------------

### Make API Request with Access Token

Source: https://developer.signicat.com/docs/accessing-api-products

This example demonstrates how to make an authenticated API request by including the obtained access token in the HTTP Authorization header using the Bearer scheme. This is a general example for a GET request.

```http
GET /auth/rest/sessions/{id} HTTP/2




```

--------------------------------

### Example Login Hint Format

Source: https://developer.signicat.com/docs/eid-hub/oidc/oidc-implementation

Demonstrates the format for the 'login_hint' query parameter, used to prefill end-user information for the Identity Provider. It accepts space-separated key-value pairs for various user attributes.

```text
login_hint=nin:199001011234 mobile:%2B447700900000
```

--------------------------------

### Setting up an OIDC client

Source: https://developer.signicat.com/cs/enterprise/identity-methods/mitid/migration

Instructions for creating a new OIDC client in the Signicat Customer Portal. This involves filling out a form with details like environment, client name, and redirect URIs.

```APIDOC
## Setting up an OIDC client

To set up a new OIDC client for authentication:

1. Log into the Signicat Customer Portal.
2. Navigate to **OIDC clients** in the left menu (requires Configuration Manager or Administrator privilege).
3. Select **Add new OIDC client**.
4. Fill in the form:
   - **Environment:** Test
   - **Client name:** Must be globally unique, recommended to start with `preprod_` followed by company or app name.
   - **Redirect URI:** Use `https://labs.signicat.com/redirect` if the URI is unknown at this point; more can be added later.
   - **National identity number** and **Profile:** Check these scopes.
5. Select **Save client**. A ticket will be sent to the Service Desk for qualification and creation.

Once the client is created, you can begin integration. Refer to 'Using the OpenID Connect protocol' for more details.
```

--------------------------------

### Start Passkey Authentication Request

Source: https://developer.signicat.com/docs/reuseid/quick-start-guides/passkeys

This JSON object represents a minimal request body to start a passkey authentication process. It requires no specific parameters for this basic example, but typically might include details for advanced configurations.

```json
{
}
```

--------------------------------

### Get MobileID Authentication State Response

Source: https://developer.signicat.com/docs/mobile-identity/mobileid/quick-start-guide

This JSON object is an example response from the 'Get state of ongoing authentication' endpoint. It provides the final status of the authentication, which is 'COMPLETED' in this case, along with timestamps and details about the device, user, and operation.

```json
{
    "accountId": "a-spge-7NS53Bt6di0YlzA9SYQO",
    "transactionId": "e33c5cd4-03d2-42ca-acc1-407a72c234ce",
    "state": "COMPLETED",
    "created": "2023-08-16T11:53:24.863Z",
    "completed": "2023-08-16T11:53:37.407Z",
    "device": {
        "id": "dc55de99-b11f-40ad-8c12-adb98be9ec61",
        "state": "ACTIVE",
        "lastOperationType": "AUTHENTICATION",
        "lastUsed": "2023-08-16T11:53:37.392Z",
        "created": "2023-08-16T11:37:19.111Z"
    },
    "user": {
        "id": "76bfe9e6-1fe2-4b92-b742-a66015a98981",
        "created": "2023-08-16T11:25:50.923Z",
        "lastUsed": "2023-08-16T11:53:37.382Z",
        "state": "ACTIVE"
    },
    "operationProperties": {
        "postOperationContext": {
            "content": "Cool! You have successfully completed a MobileID authentication",
            "mimeType": "text/plain"
        },
        "authLevel": "TWO_FACTOR",
        "authMethod": "DEVICE_IOS_FACE_ID",
        "preOperationContext": {
            "content": "Approve your first MobileID authentication",
            "mimeType": "text/plain"
        },
        "pushSent": true,
        "sessionExpiryTime": "2023-08-16T11:54:54.955Z"
    }
}
```