---
updatedAt: 2026-05-05T18:47:13.000Z
agentTools:
  projectIndex: https://docs.trinsic.id/llms.txt
---

# Get Verification Profile by External ID

Gets a specific verification profile by its customer-defined external ID.

# OpenAPI definition

```json
{
  "openapi": "3.0.4",
  "info": {
    "title": "Trinsic API",
    "version": "v1",
    "x-swaggerexclude": "External"
  },
  "servers": [
    {
      "url": "https://api.trinsic.id",
      "description": "Production server"
    },
    {
      "url": "https://api.eu.trinsic.id",
      "description": "Production server (EU data residency preview)"
    }
  ],
  "paths": {
    "/api/valpha/verification-profiles/external-ids/{externalId}": {
      "get": {
        "tags": [
          "VerificationProfiles"
        ],
        "summary": "Get Verification Profile by External ID",
        "description": "Gets a specific verification profile by its customer-defined external ID.",
        "operationId": "GetVerificationProfileByExternalId",
        "parameters": [
          {
            "name": "externalId",
            "in": "path",
            "description": "Customer-defined external ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/VerificationProfileResponse"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VerificationProfileResponse"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/VerificationProfileResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
                  "title": "Bad Request",
                  "detail": "This feature is not supported for your configuration",
                  "status": 400,
                  "traceId": "00-3fcbc632c5caaca825849d495c62d7b0-09a3500f89acbbcc-00",
                  "instance": "/api/v1/sample-request-path",
                  "errors": {
                    "PropertyName": [
                      "Specific error description for property"
                    ]
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://tools.ietf.org/html/rfc7231#section-6.6.1",
                  "title": "Unauthorized",
                  "status": 401,
                  "traceId": "00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://tools.ietf.org/html/rfc7231#section-6.6.1",
                  "title": "Forbidden",
                  "status": 403,
                  "traceId": "00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://tools.ietf.org/html/rfc7231#section-6.6.1",
                  "title": "Internal Server Error",
                  "status": 500,
                  "traceId": "00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "A URI reference that identifies the problem type.",
            "nullable": true
          },
          "title": {
            "type": "string",
            "description": "A short, human-readable summary of the error.",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "description": "The HTTP status code returned for the request.",
            "format": "int32",
            "nullable": true
          },
          "detail": {
            "type": "string",
            "description": "A human-readable explanation specific of the problem.",
            "nullable": true
          },
          "instance": {
            "type": "string",
            "description": "A URI reference that identifies the specific occurrence of the problem.",
            "nullable": true
          }
        },
        "additionalProperties": {}
      },
      "VerificationProfileResponse": {
        "required": [
          "alias",
          "brandName",
          "enabledProviders",
          "geography",
          "id",
          "isProductionUsage",
          "logoUrl",
          "primaryColor",
          "sessionExpiration"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The ID of the verification profile",
            "format": "uuid"
          },
          "alias": {
            "type": "string",
            "description": "An alias of the verification profile shown to developers and administrators."
          },
          "brandName": {
            "type": "string",
            "description": "The brand name of the verification profile shown to end-users."
          },
          "externalId": {
            "type": "string",
            "description": "A customer-defined external ID for this verification profile, unique within your organization.",
            "nullable": true
          },
          "geography": {
            "type": "string",
            "description": "The data-residency geography of the verification profile, such as \"US\" or \"EU\".",
            "example": "US"
          },
          "logoUrl": {
            "type": "string",
            "description": "The URL of the verification profile's logo."
          },
          "primaryColor": {
            "type": "string",
            "description": "The primary color of the verification profile."
          },
          "enabledProviders": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The providers that are currently enabled for the verification profile."
          },
          "sessionExpiration": {
            "type": "string",
            "description": "The session expiration for verification sessions created with this profile.",
            "format": "date-span"
          },
          "isProductionUsage": {
            "type": "boolean",
            "description": "Whether this profile is for production usage. Only applicable for Live environment profiles."
          }
        }
      }
    },
    "securitySchemes": {
      "Bearer": {
        "type": "http",
        "description": "Trinsic Connect API Key",
        "scheme": "bearer"
      }
    }
  },
  "security": [
    {
      "Bearer": []
    }
  ],
  "tags": [
    {
      "name": "VerificationProfiles"
    }
  ]
}
```