API reference · Identity & onboarding

Nationalities

GET List an account holder's nationalities

GET /accountholder/{type}/{value}/nationalities

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
type
value

Example

Response: GenericResponseListNationalityResponse

curl -X GET "https://api.bridgemoni.com/accountholder/value/value/nationalities" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200Nationalities fetched successfully

POST Record a nationality for an account holder

POST /accountholder/{type}/{value}/nationality

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Content-Typeapplication/json

Path parameters

Name
type
value

Example

Request body: NationalityRequest · Response: GenericResponseNationalityResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/nationality" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "countryCode": "NG",
  "acquisitionType": "BIRTH",
  "primaryNationality": "true",
  "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}'

Responses

StatusWhen
200Nationalities created successfully

GET Fetch one nationality

GET /nationality/{id}

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
id

Example

Response: GenericResponseNationalityResponse

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

Responses

StatusWhen
200Nationalities fetched successfully

PUT Update one nationality

PUT /nationality/{id}

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Content-Typeapplication/json

Path parameters

Name
id

Example

Request body: UpdateNationalityRequest · Response: GenericResponseNationalityResponse

curl -X PUT "https://api.bridgemoni.com/nationality/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 '{
  "countryCode": "NG",
  "acquisitionType": "BIRTH",
  "primaryNationality": "true",
  "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}'

Responses

StatusWhen
200Nationalities updated successfully

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