Signicat Onboarding API

openapi: 3.2.0
info:
  title: Signicat Onboarding API
  version: 1.0.0
  contact: ''
  license: ''
  termsOfService: ''
  description: 'Operations tagged Onboarding across 2 of this provider''s published API definitions: reuseid-onboarding-openapi.json, signicat-reuseid-onboarding-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.signicat.com
tags:
- name: Onboarding
  description: 'The ReuseID **Onboarding** API provides you with operations related to the onboarding flow, such as starting and getting information about a ReuseID session.


    ### About the onboarding flow


    1. The onboarding flow creates a MobileID user and initiates a MobileID device registration.

    2. Once the end-user has confirmed the activation code, their device is registered to their account and the identity proofing session is started.

    3. After the end-user has successfully gone through the identity proofing process, the flow updates the user information with the data from the identity proofing process.'
paths:
  /reuseid/id-onboardings:
    post:
      tags:
      - Onboarding
      summary: Start onboarding
      description: 'The **Start onboarding** endpoint initiates an onboarding session.


        In this flow, you will:


        1. Create a MobileID user.

        2. Activate a MobileID device.

        3. Perform an identity proofing.

        4. Add identity attributes to the MobileID user.'
      operationId: startOnboarding
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                externalRef: Empl10300469
                provider: signicatvideoid
                videoidProviderOptions:
                  docType: 138
                  docTypes:
                  - 138
                  - 123
                  defaultId: 138
              properties:
                externalRef: An identifier generated by you (the customer), that points to the user ID (userId) generated by ReuseID when a new user is created. The identifier must be unique in the scope of the account and have a max length of 128 characters.
                provider:
                  type: string
                  description: A parameter to specify which identify proofing provider to use. The current two providers available are `readid` and `signicatvideoid`. If no provider is supplied, then the default provider `signicatvideoid` is used.
                videoidProviderOptions:
                  type: object
                  x-stoplight:
                    id: 8w8abtld8rldf
                  description: "An object that contains parameters for deciding what kind of documents can be used, and which document should be the default. \n\n- If not specified, then all ID documents that our VideoID solution supports will be available as an option for the end-user. \n- If only one specific document is to be used, then you can specify this with `docType`. \n- If multiple documents are to be available, then you can specify this with `docTypes`. \n\n**Note**: When multiple `docTypes` are specified, we recommend that you provide a `defaultId`. This is the first option shown to the user.\n"
                  properties:
                    docType:
                      type: integer
                      x-stoplight:
                        id: ax7the523to5b
                      description: A parameter to specify a single document type that you want to be used by the end-user.
                    docTypes:
                      type: array
                      x-stoplight:
                        id: 3k6o25i683m69
                      description: A parameter to specify multiple document types that you want to be available for the end-user to choose from.
                      items:
                        x-stoplight:
                          id: n0p68nzv9mier
                        type: integer
                    defaultId:
                      type: integer
                      x-stoplight:
                        id: n6g8z5gnho2ay
                      description: 'A parameter to specify the default document type that you want to be shown to the end-user, when multiple document types are specified. This can only be used when `docTypes` has been provided.


                        **Note**: If not set, then the default is the lowest integer.

                        '
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    x-stoplight:
                      id: ehwcuvzegcu00
                    properties:
                      status:
                        type: string
                        x-stoplight:
                          id: 47oj5zuc9um37
                        example: Pending
                        description: The status of the onboarding. This can be either `Pending`, `Success` or `Failed`.
                      transactionId:
                        type: string
                        x-stoplight:
                          id: nzna4y1e5ovim
                        example: 94099e7e-b391-45fb-9404-b54682f16d03
                        description: The ID of the transaction. This is used in subsequent API requests to get the transaction data.
                      userId:
                        type: string
                        x-stoplight:
                          id: 71q6vxj1wyzvu
                        example: 7f1994f0-5fed-4e0f-a8e2-64da520a09cb
                        description: The ID of the user that carries out the operation, in a valid UUID format.
                      activationCode:
                        type: string
                        x-stoplight:
                          id: dty5iv3upy9z3
                        example: '2005468691'
                        description: The activation code, which is used to register the device in the app.
                      dossierId:
                        type: string
                        x-stoplight:
                          id: v6ukz2ep9jnfa
                        example: 41ff5755-4ece-42cf-b7de-3efd0181ba88
                        description: The ID of the dossier for the identity proofing session. This is used in API requests to get the evidence files of the identity proofing session.
                      processId:
                        type: string
                        x-stoplight:
                          id: ly2ry5k3qrzfo
                        example: 8be8325a-9654-4165-a56f-0d1ccdc3bd3e
                        description: The ID of the process for the identity proofing session. This is used in API requests to get the evidence files of the identity proofing session.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    x-stoplight:
                      id: 6u1t6ubg70xbf
                    example: missing_permission
                    description: A machine-readable string that indicates the error code. This is a constant.
                  detail:
                    type: string
                    x-stoplight:
                      id: gbn6paxdnheu5
                    example: The subject with ID 'dev-ghastly-thread-446' does not have the required permission 'risk-flow:transaction:create' on the target resource 'a-sdge-c2z0wgHkZjpBnS7uB621'
                    description: An explanation of the error, specific to this occurrence of the error.
                  traceId:
                    type: string
                    x-stoplight:
                      id: m8c7osjrppsyp
                    example: 4bf239c088089f2bca77d3a413909f1c
                    description: The unique identifier of the request in the tracing system. This makes it possible for us to trace the history of the request in detail.
                  status:
                    type: integer
                    x-stoplight:
                      id: wx3mkn9iz5gko
                    example: 403
                    description: "The HTTP status code generated by the origin server, specific to this occurrence of the error.\t"
                  title:
                    type: string
                    x-stoplight:
                      id: nrqyn2p35csvq
                    example: You do not have the required permission to perform this operation on the target resource
                    description: 'A summary of the error type. This does not change between occurrences of the error.

                      '
                  type:
                    type: string
                    x-stoplight:
                      id: 7jy72jopx87q8
                    example: https://developer.signicat.com/errors?code=missing_permission
                    description: The URI to the documentation that describes the error.
        '422':
          description: Unprocessable Entity (WebDAV)
          content:
            application/json:
              schema:
                type: object
                x-examples:
                  Example 1:
                    code: request_body_error
                    title: Bad Request
                    detail: docTypes and docType cannot be defined in the same request
                properties:
                  code:
                    type: string
                    example: request_body_error
                    description: A machine-readable string that indicates the error code. This is a constant.
                  title:
                    type: string
                    example: Bad Request
                    description: A summary of the error type. This does not change between occurrences of the error.
                  detail:
                    type: string
                    example: docTypes and docType cannot be defined in the same request
                    description: An explanation of the error, specific to this occurrence of the error.
                  status:
                    type: string
                    x-stoplight:
                      id: o1tzdjk9fjg1z
                    description: "The HTTP status code generated by the origin server, specific to this occurrence of the error.\t"
    servers:
    - url: https://api.signicat.com
  /reuseid/id-onboardings/{transactionId}:
    get:
      tags:
      - Onboarding
      summary: Get onboarding
      operationId: getOnboarding
      description: The **Get onboarding** endpoint gets data from an onboarding session.
      parameters:
      - name: transactionId
        description: The ID of the transaction, given in the **Start onboarding** session.
        in: path
        schema:
          type: string
        required: true
      - schema:
          type: string
        in: query
        name: transactionId
        description: The ID of the transaction, given in the **Start onboarding** session.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                x-examples:
                  Example 1:
                    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
                properties:
                  data:
                    type: object
                    properties:
                      transactionId:
                        type: string
                        example: e35ebbf7-9631-4966-9762-ae939c80eda1
                        description: The ID of the transaction. This is used in subsequent API requests to get the transaction data.
                      userId:
                        type: string
                        example: a1e26081-35b4-4557-a46a-ef50bc91672f
                        description: The ID of the user that carries out the operation, in a valid UUID format.
                      activationCode:
                        type: string
                        example: '8954685641'
                        description: The activation code, which is used to register the device in the app.
                      deviceId:
                        type: string
                        example: b1g73121-55c4-9238-l39j-ek60dc91872g
                        description: The ID of the end-user's device that is used for the operation.
                      proofingId:
                        type: string
                        default: 30745db7-4403-4403-aa7e-cb35435ee565
                        description: The ID of the identity verification.
                      dossierId:
                        type: string
                        example: 3d563ac4-9d26-4a6a-b58d-5a29cacfe015
                        description: The ID of the dossier for the identity proofing session. This is used in API requests to get the evidence files of the identity proofing session.
                      processId:
                        type: string
                        example: 2f54b0a4-1a77-42e2-98d8-369116ef2055
                        description: The ID of the process for the identity proofing session. This is used in API requests to get the evidence files of the identity proofing session.
                      status:
                        type: string
                        example: Completed
                        description: The status of the onboarding. This can be either `Pending`, `Success` or `Failed`.
                      userData:
                        type: object
                        description: An object containing data from the end-user, extracted from the identity proofing process.
                        properties:
                          firstName:
                            type: string
                            example: JANE
                            description: The first name of the onboarded end-user.
                          lastName:
                            type: string
                            example: SMITH
                            description: The last name of the onboarded end-user.
                          dateOfBirth:
                            type: string
                            example: '1990-01-01'
                            description: The date of birth of the onboarded end-user.
                          gender:
                            type: string
                            example: F
                            description: The gender of the onboarded end-user.
                          nationality:
                            type: string
                            example: NOR
                            description: The nationality of the onboarded end-user.
              examples:
                Example 1:
                  value:
                    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
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                x-examples:
                  Example 1:
                    code: missing_permission
                    detail: The subject with ID 'dev-ghastly-thread-446' does not have the required permission 'mobileid:user:read' on the target resource 'a-sdge-c2z0wgHkZjpBnS7uB621'
                    status: 403
                    traceId: 4bf239c088089f2bca77d3a413909f1c
                    title: You do not have the required permission to perform this operation on the target resource
                    type: https://developer.signicat.com/errors?code=missing_permission
                properties:
                  code:
                    type: string
                    example: missing_permission
                    description: A machine-readable string that indicates the error code. This is a constant.
                  detail:
                    type: string
                    example: The subject with ID 'dev-ghastly-thread-446' does not have the required permission 'risk-flow:transaction:read' on the target resource 'a-sdge-c2z0wgHkZjpBnS7uB621'
                    description: "An explanation of the error, specific to this occurrence of the error.\t"
                  status:
                    type: integer
                    example: 403
                    description: The HTTP status code generated by the origin server, specific to this occurrence of the error.
                  traceId:
                    type: string
                    example: 4bf239c088089f2bca77d3a413909f1c
                    description: The unique identifier of the request in the tracing system. This makes it possible for us to trace the history of the request in detail.
                  title:
                    type: string
                    example: You do not have the required permission to perform this operation on the target resource
                    description: A summary of the error type. This does not change between occurrences of the error.
                  type:
                    type: string
                    example: https://developer.signicat.com/errors?code=missing_permission
                    description: The URI to the documentation that describes the error.
        '404':
          description: Not Found
      x-stoplight:
        id: hw0ohm9zzfrty
    servers:
    - url: https://api.signicat.com
components:
  securitySchemes:
    Token:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: ''
          refreshUrl: ''
          scopes: {}
x-refined-from:
- reuseid-onboarding-openapi.json
- signicat-reuseid-onboarding-openapi.yml