find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/strivacity-identity-verification-policy-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: API documentation of Admin Portal
  title: Admin Portal Identity Verification Policy API
  version: v0.0.1
servers:
- url: https://{tenant}
  variables:
    tenant:
      default: example.strivacity.com
      description: Your Strivacity tenant
tags:
- name: Identity Verification Policy
paths:
  /admin/api/v1/identityProofings:
    get:
      description: 'You can list the existing identity verification policies by calling this endpoint.


        | REQUIRED API PERMISSION |

        |:------------------------|

        | read:config_identity_proofing |'
      operationId: getAllIdentityProofings
      parameters:
      - in: query
        name: fields
        required: false
        schema:
          type: array
          items:
            type: string
      - description: Tags used for filtering must exactly match the tag name
        in: query
        name: policyTags
        required: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - description: Name used for filtering
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: Zero-based page index (0..N)
        in: query
        name: page
        schema:
          type: integer
          format: int64
          default: 0
      - description: The size of the page to be returned
        in: query
        name: size
        schema:
          type: integer
          format: int64
          default: 20
      - description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.'
        in: query
        name: sort
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PagedModelIdentityProofingListResponse'
          description: OK
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Forbidden
      security:
      - securityScheme:
        - read:config_identity_proofing
      summary: List identity verification policies
      tags:
      - Identity Verification Policy
    post:
      description: 'You can create an identity verification policy by calling this endpoint.


        | REQUIRED API PERMISSION |

        |:------------------------|

        | write:config_identity_proofing |'
      operationId: createIdentityProofing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityProofing_InsertRequest'
        required: true
      responses:
        '201':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/IdentityProofingResponse_IdentityProofing'
          description: Created
        '400':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Bad Request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Forbidden
        '409':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Conflict
      security:
      - securityScheme:
        - write:config_identity_proofing
      summary: Create an identity verification policy
      tags:
      - Identity Verification Policy
  /admin/api/v1/identityProofings/{id}:
    delete:
      description: 'You can delete an identity verification policy by calling this endpoint. Identity verification policies assigned to applications cannot be deleted.


        | REQUIRED API PERMISSION |

        |:------------------------|

        | delete:config_identity_proofing |'
      operationId: deleteIdentityProofingById
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Forbidden
        '409':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: The Identity Proofing is assigned to applications or organization assignments and cannot be deleted
      security:
      - securityScheme:
        - delete:config_identity_proofing
      summary: Delete an identity verification policy
      tags:
      - Identity Verification Policy
    get:
      description: 'You can get an identity verification policy by calling this endpoint.


        | REQUIRED API PERMISSION |

        |:------------------------|

        | read:config_identity_proofing |'
      operationId: getIdentityProofingById
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/IdentityProofingResponse_IdentityProofing'
          description: OK
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Forbidden
        '404':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Not Found
      security:
      - securityScheme:
        - read:config_identity_proofing
      summary: Get an identity verification policy
      tags:
      - Identity Verification Policy
    put:
      description: 'You can update an identity verification policy by calling this endpoint.


        | REQUIRED API PERMISSION |

        |:------------------------|

        | write:config_identity_proofing |'
      operationId: updateIdentityProofing
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityProofingUpsertRequest_IdentityProofing'
        required: true
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/IdentityProofingResponse_IdentityProofing'
          description: OK
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Forbidden
        '404':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Not Found
        '409':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Conflict
      security:
      - securityScheme:
        - write:config_identity_proofing
      summary: Update an identity verification policy
      tags:
      - Identity Verification Policy
components:
  schemas:
    ProblemJson:
      type: object
      properties:
        detail:
          type: string
        entityName:
          type: string
          description: The name of the entity within the error has occurred
        errorKey:
          type: string
          description: A unique identifier of the error
        fieldErrors:
          type: array
          description: Field constraint violation errors
          items:
            $ref: '#/components/schemas/FieldError'
        message:
          type: string
          description: A unique identifier in format of 'error.{errorKey}'
        params:
          type: array
          description: Further information related to the actual error
          items:
            type: object
            additionalProperties:
              type: object
        path:
          type: string
          description: Request URI
        status:
          type: integer
          description: Status code
          format: int32
        title:
          type: string
      description: Based on [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807)
    IdentityProofingUpsertRequest_IdentityProofing:
      required:
      - failureMessage
      - id
      - name
      - proofingNotification
      type: object
      properties:
        description:
          maxLength: 1024
          minLength: 0
          type: string
        failureMessage:
          $ref: '#/components/schemas/FailureMessage_IdentityProofing'
        id:
          type: string
        name:
          maxLength: 64
          minLength: 3
          pattern: ^$|^[\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*°]([\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*° ]*[\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*°])?$
          type: string
        policyTag:
          pattern: ^[a-z0-9_]{2,32}$
          type: string
          description: Must be an existing policy tag name
        proofingNotification:
          $ref: '#/components/schemas/ProofingNotification_IdentityProofing'
    FailureMessage_IdentityProofing:
      required:
      - displayText
      type: object
      properties:
        displayText:
          maxLength: 2048
          minLength: 0
          pattern: ^((?![<>]).)*$
          type: string
      description: Represents a text to display on failed identity verification
    PagedModelIdentityProofingListResponse:
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/IdentityProofingListResponse'
        page:
          $ref: '#/components/schemas/PageMetadata'
    PageMetadata:
      type: object
      properties:
        number:
          type: integer
          format: int64
        size:
          type: integer
          format: int64
        totalElements:
          type: integer
          format: int64
        totalPages:
          type: integer
          format: int64
    ProofingDataStepConfiguration:
      type: object
      properties:
        name:
          type: string
    FieldError:
      type: object
      properties:
        field:
          type: string
        message:
          type: string
        objectName:
          type: string
    NameAndIdResponse_IdentityProofing:
      type: object
      properties:
        id:
          type: string
          description: ID of the represented entity
    ProofingNotificationResponse_IdentityProofing:
      type: object
      properties:
        consentItem:
          $ref: '#/components/schemas/NameAndIdResponse_IdentityProofing'
        consentType:
          type: string
          enum:
          - mandatory
          - mandatoryHidden
        displayText:
          $ref: '#/components/schemas/DisplayTextResponse_IdentityProofing'
        implicit:
          type: boolean
    IdentityProofingStepDTO:
      type: object
      properties:
        configuration:
          $ref: '#/components/schemas/ProofingDataStepConfiguration'
        id:
          type: string
        type:
          type: string
          enum:
          - addressRiskEvaluation
          - documentVerification
          - knowledgeBasedVerification
          - phoneNumberRiskEvaluation
          - phoneBasedIdentityAffirmation
          - proofingData
    DisplayText_IdentityProofing:
      required:
      - text
      type: object
      properties:
        enabled:
          type: boolean
          default: false
        text:
          maxLength: 2048
          minLength: 0
          pattern: ^((?![<>]).)*$
          type: string
    FailureMessageResponse_IdentityProofing:
      type: object
      properties:
        displayText:
          type: string
    DisplayTextResponse_IdentityProofing:
      type: object
      properties:
        enabled:
          type: boolean
        text:
          type: string
    ProofingNotification_IdentityProofing:
      required:
      - consentItem
      - consentType
      - displayText
      type: object
      properties:
        consentItem:
          $ref: '#/components/schemas/OnlyIdRequest_IdentityProofing'
        consentType:
          type: string
          enum:
          - mandatory
          - mandatoryHidden
        displayText:
          $ref: '#/components/schemas/DisplayText_IdentityProofing'
        implicit:
          type: boolean
          default: false
    IdentityProofingListResponse:
      type: object
      properties:
        description:
          type: string
        id:
          type: string
        name:
          type: string
        policyTag:
          type: string
        steps:
          type: array
          items:
            $ref: '#/components/schemas/IdentityProofingStepDTO'
    IdentityProofing_InsertRequest:
      required:
      - failureMessage
      - name
      - proofingNotification
      type: object
      properties:
        description:
          maxLength: 1024
          minLength: 0
          type: string
        failureMessage:
          $ref: '#/components/schemas/FailureMessage_IdentityProofing'
        name:
          maxLength: 64
          minLength: 3
          pattern: ^$|^[\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*°]([\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*° ]*[\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*°])?$
          type: string
        policyTag:
          pattern: ^[a-z0-9_]{2,32}$
          type: string
          description: Must be an existing policy tag name
        proofingNotification:
          $ref: '#/components/schemas/ProofingNotification_IdentityProofing'
    IdentityProofingResponse_IdentityProofing:
      type: object
      properties:
        description:
          type: string
        failureMessage:
          $ref: '#/components/schemas/FailureMessageResponse_IdentityProofing'
        id:
          type: string
        name:
          type: string
        policyTag:
          type: string
        proofingNotification:
          $ref: '#/components/schemas/ProofingNotificationResponse_IdentityProofing'
    OnlyIdRequest_IdentityProofing:
      required:
      - id
      type: object
      properties:
        id:
          pattern: ^[a-zA-Z0-9-]{1,36}$
          type: string
  securitySchemes:
    securityScheme:
      scheme: bearer
      type: http