Internal List Identities

get/api/evs/v1/internal/identity/list

List identities through internal API - provides same functionality as admin endpoint but accessible via internal routes without user authentication.

Query Parameters

  • organizationIdstring
    BitGo organization ID to filter identities by
    Min length: >= 1 characters
  • enterpriseIdstring
    BitGo enterprise ID to filter identities by
    Min length: >= 1 characters
  • userIdstring
    BitGo user ID to filter identities by
    Min length: >= 1 characters
  • identityIdstring
    EVS identity UUID to retrieve a specific identity
    Min length: >= 1 characters
  • allDataboolean
    When true, includes additional PII fields in the response

200 Response

identities array[object] required
transactionId string required
Min length: >= 1 characters
id string required
status string required
The status of the KYC identity: `initiating`, `awaiting document upload`, `input error`, `ssn error`, `taxid error`, `in review`, `incomplete verifications`, `awaiting signature`, `records uploaded`, `approved`, `declined`
Min length: >= 1 characters
organizationId string
Min length: >= 1 characters
enterpriseId string
Min length: >= 1 characters
userId string
Min length: >= 1 characters
createdAt string <date-time>
updatedAt string <date-time>
errorDescription string
Min length: >= 1 characters
occupation string
countryOfCitizenship string
govIdCountryOfIssuance string
politicallyExposedPerson boolean
debugStatus string
country string
countryOfResidence string
addressCity string
addressPostalCode string
addressStreet1 string
addressStreet2 string
addressSubdivision string
birthDate string <date-time>
identificationNumber string
nameFirst string
nameLast string
nameMiddle string
phoneNumber string
selectedIdClass string
debugFailureReason string
emailAddress string
contractSignerNameFull string
contractSignedDate string <date-time>
contractSignedIPAddress string
contractVersion string
userAgreesToTerms string
signatureSubmitted string
signaturesSubmitted array[string]
Allowed values: csa mpa mic wvr aca
signaturesRequired array[string]
Allowed values: csa mpa mic wvr aca

400 Response

name string
context object required
status number
additionalDetails object
retryAfter number required
error string required
requestId string required

404 Response

name string
context object required
status number
additionalDetails object
retryAfter number required
error string required
requestId string required