> ## Documentation Index
> Fetch the complete documentation index at: https://verifner.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Register an endpoint



## OpenAPI

````yaml /openapi.json post /v1/webhooks
openapi: 3.1.0
info:
  title: VerifNer API
  version: 1.0.0
  description: >-
    Identity verification for Nigerien passports and national identity cards.
    One call, a reasoned verdict: five checks with evidence, a score, VERIFIED
    at 0.90 and above, REVIEW from 0.60, REJECTED below.
servers:
  - url: https://api.verifner.com
security:
  - apiKey: []
tags:
  - name: Verify
    description: Server-to-server verification with the secret key.
  - name: Sessions
    description: >-
      Browser flows: your server opens a session, the web SDK uploads with a
      client token.
  - name: Webhooks
    description: verification.completed, signed with HMAC-SHA256, retried with backoff.
paths:
  /v1/webhooks:
    post:
      tags:
        - Webhooks
      summary: Register an endpoint
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - url
              properties:
                url:
                  type: string
                  description: https only (http for localhost)
                description:
                  type: string
                  maxLength: 200
      responses:
        '201':
          description: Endpoint with its signing secret, shown once
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/WebhookEndpoint'
                  - type: object
                    properties:
                      secret:
                        type: string
components:
  schemas:
    WebhookEndpoint:
      $schema: http://json-schema.org/draft-07/schema#
      type: object
      properties:
        id:
          type: string
        url:
          type: string
        description:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
      required:
        - id
        - url
        - description
        - created_at
      additionalProperties: false
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: '`vn_live_…` or `vn_test_…`, from the console.'

````