API reference · Identity & onboarding

Identifiers

POST/accountholder/{type}/{value}/identifierAdd a registry identifier to an account holder
GET/accountholder/{type}/{value}/identifiersList identifiers for an account holder
GET/identifier/{id}Fetch an identifier by reference
PUT/identifier/{id}Update an identifier

POST Add a registry identifier to an account holder

POST /accountholder/{type}/{value}/identifier

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`type`
`value`

Example

Request body: IdentifierRequest · Response: IdentifierResponse

curl -X POST "https://api.bridgemoni.com/accountholder/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/identifier" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "schemeName": "Ada Obi",
    "identificationNumber": "identification number",
    "issuingCountryCode": "NG",
    "verifier": "Ada Obi",
    "profileMatch": true,
    "verificationStatus": "PENDING",
    "verificationMethod": "verification method",
    "verificationDateTime": "2027-03-14T14:30:01"
  }'

{
  "schemeName": "Ada Obi",
  "identificationNumber": "identification number",
  "issuingCountryCode": "NG",
  "verifier": "Ada Obi",
  "profileMatch": true,
  "verificationStatus": "PENDING",
  "verificationMethod": "verification method",
  "verificationDateTime": "2027-03-14T14:30:01"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "schemeName": "Ada Obi",
    "identificationNumber": "identification number",
    "issuingCountryCode": "NG",
    "verifier": "Ada Obi",
    "profileMatch": true,
    "verificationStatus": "PENDING",
    "verificationMethod": "verification method",
    "verificationDateTime": "2027-03-14T14:30:01"
  },
  "description": "Add a registry identifier to an account holder"
}

Responses

Status	When
`200`	Identifier created successfully

GET List identifiers for an account holder

GET /accountholder/{type}/{value}/identifiers

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`type`
`value`

Example

Response: List<IdentifierResponse>

curl -X GET "https://api.bridgemoni.com/accountholder/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/identifiers" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "schemeName": "Ada Obi",
      "identificationNumber": "identification number",
      "issuingCountryCode": "NG",
      "verifier": "Ada Obi",
      "profileMatch": true,
      "verificationStatus": "PENDING",
      "verificationMethod": "verification method",
      "verificationDateTime": "2027-03-14T14:30:01"
    }
  ],
  "description": "List identifiers for an account holder"
}

Responses

Status	When
`200`	Identifiers fetched successfully

GET Fetch an identifier by reference

GET /identifier/{id}

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`id`

Example

Response: IdentifierResponse

curl -X GET "https://api.bridgemoni.com/identifier/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "schemeName": "Ada Obi",
    "identificationNumber": "identification number",
    "issuingCountryCode": "NG",
    "verifier": "Ada Obi",
    "profileMatch": true,
    "verificationStatus": "PENDING",
    "verificationMethod": "verification method",
    "verificationDateTime": "2027-03-14T14:30:01"
  },
  "description": "Fetch an identifier by reference"
}

Responses

Status	When
`200`	Identifier fetched successfully
`404`	No identifier exists for the given reference

PUT Update an identifier

PUT /identifier/{id}

Partially updates an identifier. Only non-null fields in the request body are applied.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`id`

Example

Request body: UpdateIdentifierRequest · Response: IdentifierResponse

curl -X PUT "https://api.bridgemoni.com/identifier/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "schemeName": "Ada Obi",
    "identificationNumber": "identification number",
    "issuingCountryCode": "NG",
    "verifier": "Ada Obi",
    "profileMatch": true,
    "verificationStatus": "PENDING",
    "verificationMethod": "verification method",
    "verificationDateTime": "2027-03-14T14:30:01"
  }'

{
  "schemeName": "Ada Obi",
  "identificationNumber": "identification number",
  "issuingCountryCode": "NG",
  "verifier": "Ada Obi",
  "profileMatch": true,
  "verificationStatus": "PENDING",
  "verificationMethod": "verification method",
  "verificationDateTime": "2027-03-14T14:30:01"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "schemeName": "Ada Obi",
    "identificationNumber": "identification number",
    "issuingCountryCode": "NG",
    "verifier": "Ada Obi",
    "profileMatch": true,
    "verificationStatus": "PENDING",
    "verificationMethod": "verification method",
    "verificationDateTime": "2027-03-14T14:30:01"
  },
  "description": "Update an identifier"
}

Responses

Status	When
`200`	Identifier updated successfully
`404`	No identifier exists for the given reference

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors